Dataexchange

This page documents function available when using the Dataexchange module, created with @service Dataexchange.

Index

Documentation

Main.Dataexchange.cancel_jobMethod
cancel_job(job_id)
cancel_job(job_id, params::Dict{String,<:Any})

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

Arguments

  • job_id: The unique identifier for a job.
Main.Dataexchange.create_data_setMethod
create_data_set(asset_type, description, name)
create_data_set(asset_type, description, name, params::Dict{String,<:Any})

This operation creates a data set.

Arguments

  • asset_type: The type of asset that is added to a data set.
  • description: A description for the data set. This value can be up to 16,348 characters long.
  • name: The name of the data set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.
Main.Dataexchange.create_event_actionMethod
create_event_action(action, event)
create_event_action(action, event, params::Dict{String,<:Any})

This operation creates an event action.

Arguments

  • action: What occurs after a certain event.
  • event: What occurs to start an action.
Main.Dataexchange.create_jobMethod
create_job(details, type)
create_job(details, type, params::Dict{String,<:Any})

This operation creates a job.

Arguments

  • details: The details for the CreateJob request.
  • type: The type of job to be created.
Main.Dataexchange.create_revisionMethod
create_revision(data_set_id)
create_revision(data_set_id, params::Dict{String,<:Any})

This operation creates a revision for a data set.

Arguments

  • data_set_id: The unique identifier for a data set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Comment": An optional comment about the revision.
  • "Tags": A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.
Main.Dataexchange.delete_assetMethod
delete_asset(asset_id, data_set_id, revision_id)
delete_asset(asset_id, data_set_id, revision_id, params::Dict{String,<:Any})

This operation deletes an asset.

Arguments

  • asset_id: The unique identifier for an asset.
  • data_set_id: The unique identifier for a data set.
  • revision_id: The unique identifier for a revision.
Main.Dataexchange.delete_data_setMethod
delete_data_set(data_set_id)
delete_data_set(data_set_id, params::Dict{String,<:Any})

This operation deletes a data set.

Arguments

  • data_set_id: The unique identifier for a data set.
Main.Dataexchange.delete_event_actionMethod
delete_event_action(event_action_id)
delete_event_action(event_action_id, params::Dict{String,<:Any})

This operation deletes the event action.

Arguments

  • event_action_id: The unique identifier for the event action.
Main.Dataexchange.delete_revisionMethod
delete_revision(data_set_id, revision_id)
delete_revision(data_set_id, revision_id, params::Dict{String,<:Any})

This operation deletes a revision.

Arguments

  • data_set_id: The unique identifier for a data set.
  • revision_id: The unique identifier for a revision.
Main.Dataexchange.get_assetMethod
get_asset(asset_id, data_set_id, revision_id)
get_asset(asset_id, data_set_id, revision_id, params::Dict{String,<:Any})

This operation returns information about an asset.

Arguments

  • asset_id: The unique identifier for an asset.
  • data_set_id: The unique identifier for a data set.
  • revision_id: The unique identifier for a revision.
Main.Dataexchange.get_data_setMethod
get_data_set(data_set_id)
get_data_set(data_set_id, params::Dict{String,<:Any})

This operation returns information about a data set.

Arguments

  • data_set_id: The unique identifier for a data set.
Main.Dataexchange.get_event_actionMethod
get_event_action(event_action_id)
get_event_action(event_action_id, params::Dict{String,<:Any})

This operation retrieves information about an event action.

Arguments

  • event_action_id: The unique identifier for the event action.
Main.Dataexchange.get_jobMethod
get_job(job_id)
get_job(job_id, params::Dict{String,<:Any})

This operation returns information about a job.

Arguments

  • job_id: The unique identifier for a job.
Main.Dataexchange.get_revisionMethod
get_revision(data_set_id, revision_id)
get_revision(data_set_id, revision_id, params::Dict{String,<:Any})

This operation returns information about a revision.

Arguments

  • data_set_id: The unique identifier for a data set.
  • revision_id: The unique identifier for a revision.
Main.Dataexchange.list_data_set_revisionsMethod
list_data_set_revisions(data_set_id)
list_data_set_revisions(data_set_id, params::Dict{String,<:Any})

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

Arguments

  • data_set_id: The unique identifier for a data set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results returned by a single call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
Main.Dataexchange.list_data_setsMethod
list_data_sets()
list_data_sets(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results returned by a single call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
  • "origin": A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).
Main.Dataexchange.list_event_actionsMethod
list_event_actions()
list_event_actions(params::Dict{String,<:Any})

This operation lists your event actions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "eventSourceId": The unique identifier for the event source.
  • "maxResults": The maximum number of results returned by a single call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
Main.Dataexchange.list_jobsMethod
list_jobs()
list_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "dataSetId": The unique identifier for a data set.
  • "maxResults": The maximum number of results returned by a single call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
  • "revisionId": The unique identifier for a revision.
Main.Dataexchange.list_revision_assetsMethod
list_revision_assets(data_set_id, revision_id)
list_revision_assets(data_set_id, revision_id, params::Dict{String,<:Any})

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

Arguments

  • data_set_id: The unique identifier for a data set.
  • revision_id: The unique identifier for a revision.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results returned by a single call.
  • "nextToken": The token value retrieved from a previous call to access the next page of results.
Main.Dataexchange.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

This operation lists the tags on the resource.

Arguments

  • resource_arn: An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
Main.Dataexchange.revoke_revisionMethod
revoke_revision(data_set_id, revision_id, revocation_comment)
revoke_revision(data_set_id, revision_id, revocation_comment, params::Dict{String,<:Any})

This operation revokes subscribers' access to a revision.

Arguments

  • data_set_id: The unique identifier for a data set.
  • revision_id: The unique identifier for a revision.
  • revocation_comment: A required comment to inform subscribers of the reason their access to the revision was revoked.
Main.Dataexchange.send_api_assetMethod
send_api_asset(x-amzn-dataexchange-asset-id, x-amzn-dataexchange-data-set-id, x-amzn-dataexchange-revision-id)
send_api_asset(x-amzn-dataexchange-asset-id, x-amzn-dataexchange-data-set-id, x-amzn-dataexchange-revision-id, params::Dict{String,<:Any})

This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.

Arguments

  • x-amzn-dataexchange-asset-id: Asset ID value for the API request.
  • x-amzn-dataexchange-data-set-id: Data set ID value for the API request.
  • x-amzn-dataexchange-revision-id: Revision ID value for the API request.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Body": The request body.
  • "QueryStringParameters": Attach query string parameters to the end of the URI (for example, /v1/examplePath?exampleParam=exampleValue).
  • "x-amzn-dataexchange-header-": Any header value prefixed with x-amzn-dataexchange-header- will have that stripped before sending the Asset API request. Use this when you want to override a header that AWS Data Exchange uses. Alternatively, you can use the header without a prefix to the HTTP request.
  • "x-amzn-dataexchange-http-method": HTTP method value for the API request. Alternatively, you can use the appropriate verb in your request.
  • "x-amzn-dataexchange-path": URI path value for the API request. Alternatively, you can set the URI path directly by invoking /v1/{pathValue}.
Main.Dataexchange.start_jobMethod
start_job(job_id)
start_job(job_id, params::Dict{String,<:Any})

This operation starts a job.

Arguments

  • job_id: The unique identifier for a job.
Main.Dataexchange.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

This operation tags a resource.

Arguments

  • resource_arn: An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
  • tags: A label that consists of a customer-defined key and an optional value.
Main.Dataexchange.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

This operation removes one or more tags from a resource.

Arguments

  • resource_arn: An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
  • tag_keys: The key tags.
Main.Dataexchange.update_assetMethod
update_asset(asset_id, data_set_id, name, revision_id)
update_asset(asset_id, data_set_id, name, revision_id, params::Dict{String,<:Any})

This operation updates an asset.

Arguments

  • asset_id: The unique identifier for an asset.
  • data_set_id: The unique identifier for a data set.
  • name: The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in the LF-tag policy" or "Table(s) included in LF-tag policy" are used as the name.
  • revision_id: The unique identifier for a revision.
Main.Dataexchange.update_data_setMethod
update_data_set(data_set_id)
update_data_set(data_set_id, params::Dict{String,<:Any})

This operation updates a data set.

Arguments

  • data_set_id: The unique identifier for a data set.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Description": The description for the data set.
  • "Name": The name of the data set.
Main.Dataexchange.update_event_actionMethod
update_event_action(event_action_id)
update_event_action(event_action_id, params::Dict{String,<:Any})

This operation updates the event action.

Arguments

  • event_action_id: The unique identifier for the event action.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Action": What occurs after a certain event.
Main.Dataexchange.update_revisionMethod
update_revision(data_set_id, revision_id)
update_revision(data_set_id, revision_id, params::Dict{String,<:Any})

This operation updates a revision.

Arguments

  • data_set_id: The unique identifier for a data set.
  • revision_id: The unique identifier for a revision.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Comment": An optional comment about the revision.
  • "Finalized": Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.