Dataexchange

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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).

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.

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.

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.

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.

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.

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}.

send_data_set_notification(data_set_id, type)
send_data_set_notification(data_set_id, type, params::Dict{String,<:Any})

The type of event associated with the data set.

Arguments

• data_set_id: Affected data set of the notification.
• type: The type of the notification. Describing the kind of event the notification is alerting you to.

Optional Parameters

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

• "ClientToken": Idempotency key for the notification, this key allows us to deduplicate notifications that are sent in quick succession erroneously.
• "Comment": Free-form text field for providers to add information about their notifications.
• "Details": Extra details specific to this notification type.
• "Scope": Affected scope of this notification such as the underlying resources affected by the notification event.

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.

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.

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.

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.

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.

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.

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.