dataexchange/aws.sdk.kotlin.services.dataexchange/DataExchangeClient

DataExchangeClient

interface DataExchangeClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<DataExchangeClient.Config, DataExchangeClient.Config.Builder, DataExchangeClient>

Companion

object Companion : AbstractAwsSdkClientFactory<DataExchangeClient.Config, DataExchangeClient.Config.Builder, DataExchangeClient, DataExchangeClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: DataExchangeClient.Config

DataExchangeClient's configuration

Functions

acceptDataGrant

abstract suspend fun acceptDataGrant(input: AcceptDataGrantRequest): AcceptDataGrantResponse

This operation accepts a data grant.

cancelJob

abstract suspend fun cancelJob(input: CancelJobRequest): CancelJobResponse

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

createDataGrant

abstract suspend fun createDataGrant(input: CreateDataGrantRequest): CreateDataGrantResponse

This operation creates a data grant.

createDataSet

abstract suspend fun createDataSet(input: CreateDataSetRequest): CreateDataSetResponse

This operation creates a data set.

createEventAction

abstract suspend fun createEventAction(input: CreateEventActionRequest): CreateEventActionResponse

This operation creates an event action.

createJob

abstract suspend fun createJob(input: CreateJobRequest): CreateJobResponse

This operation creates a job.

createRevision

abstract suspend fun createRevision(input: CreateRevisionRequest): CreateRevisionResponse

This operation creates a revision for a data set.

deleteAsset

abstract suspend fun deleteAsset(input: DeleteAssetRequest): DeleteAssetResponse

This operation deletes an asset.

deleteDataGrant

abstract suspend fun deleteDataGrant(input: DeleteDataGrantRequest): DeleteDataGrantResponse

This operation deletes a data grant.

deleteDataSet

abstract suspend fun deleteDataSet(input: DeleteDataSetRequest): DeleteDataSetResponse

This operation deletes a data set.

deleteEventAction

abstract suspend fun deleteEventAction(input: DeleteEventActionRequest): DeleteEventActionResponse

This operation deletes the event action.

deleteRevision

abstract suspend fun deleteRevision(input: DeleteRevisionRequest): DeleteRevisionResponse

This operation deletes a revision.

getAsset

abstract suspend fun getAsset(input: GetAssetRequest): GetAssetResponse

This operation returns information about an asset.

getDataGrant

abstract suspend fun getDataGrant(input: GetDataGrantRequest): GetDataGrantResponse

This operation returns information about a data grant.

getDataSet

abstract suspend fun getDataSet(input: GetDataSetRequest): GetDataSetResponse

This operation returns information about a data set.

getEventAction

abstract suspend fun getEventAction(input: GetEventActionRequest): GetEventActionResponse

This operation retrieves information about an event action.

getJob

abstract suspend fun getJob(input: GetJobRequest): GetJobResponse

This operation returns information about a job.

getReceivedDataGrant

abstract suspend fun getReceivedDataGrant(input: GetReceivedDataGrantRequest): GetReceivedDataGrantResponse

This operation returns information about a received data grant.

getRevision

abstract suspend fun getRevision(input: GetRevisionRequest): GetRevisionResponse

This operation returns information about a revision.

listDataGrants

abstract suspend fun listDataGrants(input: ListDataGrantsRequest = ListDataGrantsRequest { }): ListDataGrantsResponse

This operation returns information about all data grants.

listDataSetRevisions

abstract suspend fun listDataSetRevisions(input: ListDataSetRevisionsRequest): ListDataSetRevisionsResponse

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

listDataSets

abstract suspend fun listDataSets(input: ListDataSetsRequest = ListDataSetsRequest { }): ListDataSetsResponse

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.

listEventActions

abstract suspend fun listEventActions(input: ListEventActionsRequest = ListEventActionsRequest { }): ListEventActionsResponse

This operation lists your event actions.

listJobs

abstract suspend fun listJobs(input: ListJobsRequest = ListJobsRequest { }): ListJobsResponse

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

listReceivedDataGrants

abstract suspend fun listReceivedDataGrants(input: ListReceivedDataGrantsRequest = ListReceivedDataGrantsRequest { }): ListReceivedDataGrantsResponse

This operation returns information about all received data grants.

listRevisionAssets

abstract suspend fun listRevisionAssets(input: ListRevisionAssetsRequest): ListRevisionAssetsResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

This operation lists the tags on the resource.

revokeRevision

abstract suspend fun revokeRevision(input: RevokeRevisionRequest): RevokeRevisionResponse

This operation revokes subscribers' access to a revision.

sendApiAsset

abstract suspend fun sendApiAsset(input: SendApiAssetRequest): SendApiAssetResponse

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

sendDataSetNotification

abstract suspend fun sendDataSetNotification(input: SendDataSetNotificationRequest): SendDataSetNotificationResponse

The type of event associated with the data set.

startJob

abstract suspend fun startJob(input: StartJobRequest): StartJobResponse

This operation starts a job.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

This operation tags a resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

This operation removes one or more tags from a resource.

updateAsset

abstract suspend fun updateAsset(input: UpdateAssetRequest): UpdateAssetResponse

This operation updates an asset.

updateDataSet

abstract suspend fun updateDataSet(input: UpdateDataSetRequest): UpdateDataSetResponse

This operation updates a data set.

updateEventAction

abstract suspend fun updateEventAction(input: UpdateEventActionRequest): UpdateEventActionResponse

This operation updates the event action.

updateRevision

abstract suspend fun updateRevision(input: UpdateRevisionRequest): UpdateRevisionResponse

This operation updates a revision.

Inherited functions

acceptDataGrant

inline suspend fun DataExchangeClient.acceptDataGrant(crossinline block: AcceptDataGrantRequest.Builder.() -> Unit): AcceptDataGrantResponse

This operation accepts a data grant.

cancelJob

inline suspend fun DataExchangeClient.cancelJob(crossinline block: CancelJobRequest.Builder.() -> Unit): CancelJobResponse

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

expect abstract fun close()

createDataGrant

inline suspend fun DataExchangeClient.createDataGrant(crossinline block: CreateDataGrantRequest.Builder.() -> Unit): CreateDataGrantResponse

This operation creates a data grant.

createDataSet

inline suspend fun DataExchangeClient.createDataSet(crossinline block: CreateDataSetRequest.Builder.() -> Unit): CreateDataSetResponse

This operation creates a data set.

createEventAction

inline suspend fun DataExchangeClient.createEventAction(crossinline block: CreateEventActionRequest.Builder.() -> Unit): CreateEventActionResponse

This operation creates an event action.

createJob

inline suspend fun DataExchangeClient.createJob(crossinline block: CreateJobRequest.Builder.() -> Unit): CreateJobResponse

This operation creates a job.

createRevision

inline suspend fun DataExchangeClient.createRevision(crossinline block: CreateRevisionRequest.Builder.() -> Unit): CreateRevisionResponse

This operation creates a revision for a data set.

deleteAsset

inline suspend fun DataExchangeClient.deleteAsset(crossinline block: DeleteAssetRequest.Builder.() -> Unit): DeleteAssetResponse

This operation deletes an asset.

deleteDataGrant

inline suspend fun DataExchangeClient.deleteDataGrant(crossinline block: DeleteDataGrantRequest.Builder.() -> Unit): DeleteDataGrantResponse

This operation deletes a data grant.

deleteDataSet

inline suspend fun DataExchangeClient.deleteDataSet(crossinline block: DeleteDataSetRequest.Builder.() -> Unit): DeleteDataSetResponse

This operation deletes a data set.

deleteEventAction

inline suspend fun DataExchangeClient.deleteEventAction(crossinline block: DeleteEventActionRequest.Builder.() -> Unit): DeleteEventActionResponse

This operation deletes the event action.

deleteRevision

inline suspend fun DataExchangeClient.deleteRevision(crossinline block: DeleteRevisionRequest.Builder.() -> Unit): DeleteRevisionResponse

This operation deletes a revision.

getAsset

inline suspend fun DataExchangeClient.getAsset(crossinline block: GetAssetRequest.Builder.() -> Unit): GetAssetResponse

This operation returns information about an asset.

getDataGrant

inline suspend fun DataExchangeClient.getDataGrant(crossinline block: GetDataGrantRequest.Builder.() -> Unit): GetDataGrantResponse

This operation returns information about a data grant.

getDataSet

inline suspend fun DataExchangeClient.getDataSet(crossinline block: GetDataSetRequest.Builder.() -> Unit): GetDataSetResponse

This operation returns information about a data set.

getEventAction

inline suspend fun DataExchangeClient.getEventAction(crossinline block: GetEventActionRequest.Builder.() -> Unit): GetEventActionResponse

This operation retrieves information about an event action.

getJob

inline suspend fun DataExchangeClient.getJob(crossinline block: GetJobRequest.Builder.() -> Unit): GetJobResponse

This operation returns information about a job.

getReceivedDataGrant

inline suspend fun DataExchangeClient.getReceivedDataGrant(crossinline block: GetReceivedDataGrantRequest.Builder.() -> Unit): GetReceivedDataGrantResponse

This operation returns information about a received data grant.

getRevision

inline suspend fun DataExchangeClient.getRevision(crossinline block: GetRevisionRequest.Builder.() -> Unit): GetRevisionResponse

This operation returns information about a revision.

listDataGrants

inline suspend fun DataExchangeClient.listDataGrants(crossinline block: ListDataGrantsRequest.Builder.() -> Unit): ListDataGrantsResponse

This operation returns information about all data grants.

listDataGrantsPaginated

fun DataExchangeClient.listDataGrantsPaginated(initialRequest: ListDataGrantsRequest = ListDataGrantsRequest { }): Flow<ListDataGrantsResponse>

fun DataExchangeClient.listDataGrantsPaginated(block: ListDataGrantsRequest.Builder.() -> Unit): Flow<ListDataGrantsResponse>

Paginate over ListDataGrantsResponse results.

listDataSetRevisions

inline suspend fun DataExchangeClient.listDataSetRevisions(crossinline block: ListDataSetRevisionsRequest.Builder.() -> Unit): ListDataSetRevisionsResponse

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

listDataSetRevisionsPaginated

fun DataExchangeClient.listDataSetRevisionsPaginated(initialRequest: ListDataSetRevisionsRequest): Flow<ListDataSetRevisionsResponse>

fun DataExchangeClient.listDataSetRevisionsPaginated(block: ListDataSetRevisionsRequest.Builder.() -> Unit): Flow<ListDataSetRevisionsResponse>

Paginate over ListDataSetRevisionsResponse results.

listDataSets

inline suspend fun DataExchangeClient.listDataSets(crossinline block: ListDataSetsRequest.Builder.() -> Unit): ListDataSetsResponse

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.

listDataSetsPaginated

fun DataExchangeClient.listDataSetsPaginated(initialRequest: ListDataSetsRequest = ListDataSetsRequest { }): Flow<ListDataSetsResponse>

fun DataExchangeClient.listDataSetsPaginated(block: ListDataSetsRequest.Builder.() -> Unit): Flow<ListDataSetsResponse>

Paginate over ListDataSetsResponse results.

listEventActions

inline suspend fun DataExchangeClient.listEventActions(crossinline block: ListEventActionsRequest.Builder.() -> Unit): ListEventActionsResponse

This operation lists your event actions.

listEventActionsPaginated

fun DataExchangeClient.listEventActionsPaginated(initialRequest: ListEventActionsRequest = ListEventActionsRequest { }): Flow<ListEventActionsResponse>

fun DataExchangeClient.listEventActionsPaginated(block: ListEventActionsRequest.Builder.() -> Unit): Flow<ListEventActionsResponse>

Paginate over ListEventActionsResponse results.

listJobs

inline suspend fun DataExchangeClient.listJobs(crossinline block: ListJobsRequest.Builder.() -> Unit): ListJobsResponse

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

listJobsPaginated

fun DataExchangeClient.listJobsPaginated(initialRequest: ListJobsRequest = ListJobsRequest { }): Flow<ListJobsResponse>

fun DataExchangeClient.listJobsPaginated(block: ListJobsRequest.Builder.() -> Unit): Flow<ListJobsResponse>

Paginate over ListJobsResponse results.

listReceivedDataGrants

inline suspend fun DataExchangeClient.listReceivedDataGrants(crossinline block: ListReceivedDataGrantsRequest.Builder.() -> Unit): ListReceivedDataGrantsResponse

This operation returns information about all received data grants.

listReceivedDataGrantsPaginated

fun DataExchangeClient.listReceivedDataGrantsPaginated(initialRequest: ListReceivedDataGrantsRequest = ListReceivedDataGrantsRequest { }): Flow<ListReceivedDataGrantsResponse>

fun DataExchangeClient.listReceivedDataGrantsPaginated(block: ListReceivedDataGrantsRequest.Builder.() -> Unit): Flow<ListReceivedDataGrantsResponse>

Paginate over ListReceivedDataGrantsResponse results.

listRevisionAssets

inline suspend fun DataExchangeClient.listRevisionAssets(crossinline block: ListRevisionAssetsRequest.Builder.() -> Unit): ListRevisionAssetsResponse

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

listRevisionAssetsPaginated

fun DataExchangeClient.listRevisionAssetsPaginated(initialRequest: ListRevisionAssetsRequest): Flow<ListRevisionAssetsResponse>

fun DataExchangeClient.listRevisionAssetsPaginated(block: ListRevisionAssetsRequest.Builder.() -> Unit): Flow<ListRevisionAssetsResponse>

Paginate over ListRevisionAssetsResponse results.

listTagsForResource

inline suspend fun DataExchangeClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

This operation lists the tags on the resource.

revokeRevision

inline suspend fun DataExchangeClient.revokeRevision(crossinline block: RevokeRevisionRequest.Builder.() -> Unit): RevokeRevisionResponse

This operation revokes subscribers' access to a revision.

sendApiAsset

inline suspend fun DataExchangeClient.sendApiAsset(crossinline block: SendApiAssetRequest.Builder.() -> Unit): SendApiAssetResponse

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

sendDataSetNotification

inline suspend fun DataExchangeClient.sendDataSetNotification(crossinline block: SendDataSetNotificationRequest.Builder.() -> Unit): SendDataSetNotificationResponse

The type of event associated with the data set.

startJob

inline suspend fun DataExchangeClient.startJob(crossinline block: StartJobRequest.Builder.() -> Unit): StartJobResponse

This operation starts a job.

tagResource

inline suspend fun DataExchangeClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

This operation tags a resource.

untagResource

inline suspend fun DataExchangeClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

This operation removes one or more tags from a resource.

updateAsset

inline suspend fun DataExchangeClient.updateAsset(crossinline block: UpdateAssetRequest.Builder.() -> Unit): UpdateAssetResponse

This operation updates an asset.

updateDataSet

inline suspend fun DataExchangeClient.updateDataSet(crossinline block: UpdateDataSetRequest.Builder.() -> Unit): UpdateDataSetResponse

This operation updates a data set.

updateEventAction

inline suspend fun DataExchangeClient.updateEventAction(crossinline block: UpdateEventActionRequest.Builder.() -> Unit): UpdateEventActionResponse

This operation updates the event action.

updateRevision

inline suspend fun DataExchangeClient.updateRevision(crossinline block: UpdateRevisionRequest.Builder.() -> Unit): UpdateRevisionResponse

This operation updates a revision.

withConfig

fun DataExchangeClient.withConfig(block: DataExchangeClient.Config.Builder.() -> Unit): DataExchangeClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.