Dataexchange
This page documents function available when using the Dataexchange module, created with @service Dataexchange.
Index
Main.Dataexchange.cancel_jobMain.Dataexchange.create_data_setMain.Dataexchange.create_jobMain.Dataexchange.create_revisionMain.Dataexchange.delete_assetMain.Dataexchange.delete_data_setMain.Dataexchange.delete_revisionMain.Dataexchange.get_assetMain.Dataexchange.get_data_setMain.Dataexchange.get_jobMain.Dataexchange.get_revisionMain.Dataexchange.list_data_set_revisionsMain.Dataexchange.list_data_setsMain.Dataexchange.list_jobsMain.Dataexchange.list_revision_assetsMain.Dataexchange.list_tags_for_resourceMain.Dataexchange.start_jobMain.Dataexchange.tag_resourceMain.Dataexchange.untag_resourceMain.Dataexchange.update_assetMain.Dataexchange.update_data_setMain.Dataexchange.update_revision
Documentation
Main.Dataexchange.cancel_job — Methodcancel_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_set — Methodcreate_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 file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.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_job — Methodcreate_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_revision — Methodcreate_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_asset — Methoddelete_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_set — Methoddelete_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_revision — Methoddelete_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_asset — Methodget_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_set — Methodget_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_job — Methodget_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_revision — Methodget_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_revisions — Methodlist_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_sets — Methodlist_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_jobs — Methodlist_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_assets — Methodlist_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_resource — Methodlist_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.start_job — Methodstart_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_resource — Methodtag_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_resource — Methoduntag_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_asset — Methodupdate_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 S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.revision_id: The unique identifier for a revision.
Main.Dataexchange.update_data_set — Methodupdate_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_revision — Methodupdate_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.