- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
DataExchangeClient
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.
Installation
npm install @aws-sdk/client-dataexchangeyarn add @aws-sdk/client-dataexchangepnpm add @aws-sdk/client-dataexchangeDataExchangeClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| AcceptDataGrantCommand | This operation accepts a data grant. |
| CancelJobCommand | This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state. |
| CreateDataGrantCommand | This operation creates a data grant. |
| CreateDataSetCommand | This operation creates a data set. |
| CreateEventActionCommand | This operation creates an event action. |
| CreateJobCommand | This operation creates a job. |
| CreateRevisionCommand | This operation creates a revision for a data set. |
| DeleteAssetCommand | This operation deletes an asset. |
| DeleteDataGrantCommand | This operation deletes a data grant. |
| DeleteDataSetCommand | This operation deletes a data set. |
| DeleteEventActionCommand | This operation deletes the event action. |
| DeleteRevisionCommand | This operation deletes a revision. |
| GetAssetCommand | This operation returns information about an asset. |
| GetDataGrantCommand | This operation returns information about a data grant. |
| GetDataSetCommand | This operation returns information about a data set. |
| GetEventActionCommand | This operation retrieves information about an event action. |
| GetJobCommand | This operation returns information about a job. |
| GetReceivedDataGrantCommand | This operation returns information about a received data grant. |
| GetRevisionCommand | This operation returns information about a revision. |
| ListDataGrantsCommand | This operation returns information about all data grants. |
| ListDataSetRevisionsCommand | This operation lists a data set's revisions sorted by CreatedAt in descending order. |
| ListDataSetsCommand | 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. |
| ListEventActionsCommand | This operation lists your event actions. |
| ListJobsCommand | This operation lists your jobs sorted by CreatedAt in descending order. |
| ListReceivedDataGrantsCommand | This operation returns information about all received data grants. |
| ListRevisionAssetsCommand | This operation lists a revision's assets sorted alphabetically in descending order. |
| ListTagsForResourceCommand | This operation lists the tags on the resource. |
| RevokeRevisionCommand | This operation revokes subscribers' access to a revision. |
| SendApiAssetCommand | This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API. |
| SendDataSetNotificationCommand | The type of event associated with the data set. |
| StartJobCommand | This operation starts a job. |
| TagResourceCommand | This operation tags a resource. |
| UntagResourceCommand | This operation removes one or more tags from a resource. |
| UpdateAssetCommand | This operation updates an asset. |
| UpdateDataSetCommand | This operation updates a data set. |
| UpdateEventActionCommand | This operation updates the event action. |
| UpdateRevisionCommand | This operation updates a revision. |
DataExchangeClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: DataExchangeClientConfig