AWSDataExchange (AWS SDK for Java

All Known Subinterfaces:

AWSDataExchangeAsync

All Known Implementing Classes:

AbstractAWSDataExchange, AbstractAWSDataExchangeAsync, AWSDataExchangeAsyncClient, AWSDataExchangeClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSDataExchange
```
Interface for accessing AWS Data Exchange.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSDataExchange instead.

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

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelJobResult`	`cancelJob(CancelJobRequest cancelJobRequest)` This operation cancels a job.
`CreateDataSetResult`	`createDataSet(CreateDataSetRequest createDataSetRequest)` This operation creates a data set.
`CreateJobResult`	`createJob(CreateJobRequest createJobRequest)` This operation creates a job.
`CreateRevisionResult`	`createRevision(CreateRevisionRequest createRevisionRequest)` This operation creates a revision for a data set.
`DeleteAssetResult`	`deleteAsset(DeleteAssetRequest deleteAssetRequest)` This operation deletes an asset.
`DeleteDataSetResult`	`deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)` This operation deletes a data set.
`DeleteRevisionResult`	`deleteRevision(DeleteRevisionRequest deleteRevisionRequest)` This operation deletes a revision.
`GetAssetResult`	`getAsset(GetAssetRequest getAssetRequest)` This operation returns information about an asset.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDataSetResult`	`getDataSet(GetDataSetRequest getDataSetRequest)` This operation returns information about a data set.
`GetJobResult`	`getJob(GetJobRequest getJobRequest)` This operation returns information about a job.
`GetRevisionResult`	`getRevision(GetRevisionRequest getRevisionRequest)` This operation returns information about a revision.
`ListDataSetRevisionsResult`	`listDataSetRevisions(ListDataSetRevisionsRequest listDataSetRevisionsRequest)` This operation lists a data set's revisions sorted by CreatedAt in descending order.
`ListDataSetsResult`	`listDataSets(ListDataSetsRequest listDataSetsRequest)` This operation lists your data sets.
`ListJobsResult`	`listJobs(ListJobsRequest listJobsRequest)` This operation lists your jobs sorted by CreatedAt in descending order.
`ListRevisionAssetsResult`	`listRevisionAssets(ListRevisionAssetsRequest listRevisionAssetsRequest)` This operation lists a revision's assets sorted alphabetically in descending order.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` This operation lists the tags on the resource.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartJobResult`	`startJob(StartJobRequest startJobRequest)` This operation starts a job.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` This operation tags a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` This operation removes one or more tags from a resource.
`UpdateAssetResult`	`updateAsset(UpdateAssetRequest updateAssetRequest)` This operation updates an asset.
`UpdateDataSetResult`	`updateDataSet(UpdateDataSetRequest updateDataSetRequest)` This operation updates a data set.
`UpdateRevisionResult`	`updateRevision(UpdateRevisionRequest updateRevisionRequest)` This operation updates a revision.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - cancelJob
```
CancelJobResult cancelJob(CancelJobRequest cancelJobRequest)
```
    This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
    
    Parameters:
    
    cancelJobRequest -
    
    Returns:
    
    Result of the CancelJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    ConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - createDataSet
```
CreateDataSetResult createDataSet(CreateDataSetRequest createDataSetRequest)
```
    This operation creates a data set.
    
    Parameters:
    
    createDataSetRequest - The request body for CreateDataSet.
    
    Returns:
    
    Result of the CreateDataSet operation returned by the service.
    
    Throws:
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    ServiceLimitExceededException - 402 response
    
    AccessDeniedException - 403 response
    
    See Also:
    
    AWS API Documentation
  - createJob
```
CreateJobResult createJob(CreateJobRequest createJobRequest)
```
    This operation creates a job.
    
    Parameters:
    
    createJobRequest - The request body for CreateJob.
    
    Returns:
    
    Result of the CreateJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    See Also:
    
    AWS API Documentation
  - createRevision
```
CreateRevisionResult createRevision(CreateRevisionRequest createRevisionRequest)
```
    This operation creates a revision for a data set.
    
    Parameters:
    
    createRevisionRequest - The request body for CreateRevision.
    
    Returns:
    
    Result of the CreateRevision operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    See Also:
    
    AWS API Documentation
  - deleteAsset
```
DeleteAssetResult deleteAsset(DeleteAssetRequest deleteAssetRequest)
```
    This operation deletes an asset.
    
    Parameters:
    
    deleteAssetRequest -
    
    Returns:
    
    Result of the DeleteAsset operation returned by the service.
    
    Throws:
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - deleteDataSet
```
DeleteDataSetResult deleteDataSet(DeleteDataSetRequest deleteDataSetRequest)
```
    This operation deletes a data set.
    
    Parameters:
    
    deleteDataSetRequest -
    
    Returns:
    
    Result of the DeleteDataSet operation returned by the service.
    
    Throws:
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - deleteRevision
```
DeleteRevisionResult deleteRevision(DeleteRevisionRequest deleteRevisionRequest)
```
    This operation deletes a revision.
    
    Parameters:
    
    deleteRevisionRequest -
    
    Returns:
    
    Result of the DeleteRevision operation returned by the service.
    
    Throws:
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - getAsset
```
GetAssetResult getAsset(GetAssetRequest getAssetRequest)
```
    This operation returns information about an asset.
    
    Parameters:
    
    getAssetRequest -
    
    Returns:
    
    Result of the GetAsset operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - getDataSet
```
GetDataSetResult getDataSet(GetDataSetRequest getDataSetRequest)
```
    This operation returns information about a data set.
    
    Parameters:
    
    getDataSetRequest -
    
    Returns:
    
    Result of the GetDataSet operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - getJob
```
GetJobResult getJob(GetJobRequest getJobRequest)
```
    This operation returns information about a job.
    
    Parameters:
    
    getJobRequest -
    
    Returns:
    
    Result of the GetJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - getRevision
```
GetRevisionResult getRevision(GetRevisionRequest getRevisionRequest)
```
    This operation returns information about a revision.
    
    Parameters:
    
    getRevisionRequest -
    
    Returns:
    
    Result of the GetRevision operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - listDataSetRevisions
```
ListDataSetRevisionsResult listDataSetRevisions(ListDataSetRevisionsRequest listDataSetRevisionsRequest)
```
    This operation lists a data set's revisions sorted by CreatedAt in descending order.
    
    Parameters:
    
    listDataSetRevisionsRequest -
    
    Returns:
    
    Result of the ListDataSetRevisions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - listDataSets
```
ListDataSetsResult listDataSets(ListDataSetsRequest listDataSetsRequest)
```
    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.
    
    Parameters:
    
    listDataSetsRequest -
    
    Returns:
    
    Result of the ListDataSets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - listJobs
```
ListJobsResult listJobs(ListJobsRequest listJobsRequest)
```
    This operation lists your jobs sorted by CreatedAt in descending order.
    
    Parameters:
    
    listJobsRequest -
    
    Returns:
    
    Result of the ListJobs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - listRevisionAssets
```
ListRevisionAssetsResult listRevisionAssets(ListRevisionAssetsRequest listRevisionAssetsRequest)
```
    This operation lists a revision's assets sorted alphabetically in descending order.
    
    Parameters:
    
    listRevisionAssetsRequest -
    
    Returns:
    
    Result of the ListRevisionAssets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    This operation lists the tags on the resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startJob
```
StartJobResult startJob(StartJobRequest startJobRequest)
```
    This operation starts a job.
    
    Parameters:
    
    startJobRequest -
    
    Returns:
    
    Result of the StartJob operation returned by the service.
    
    Throws:
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    This operation tags a resource.
    
    Parameters:
    
    tagResourceRequest - The request body for TagResource.
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    This operation removes one or more tags from a resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAsset
```
UpdateAssetResult updateAsset(UpdateAssetRequest updateAssetRequest)
```
    This operation updates an asset.
    
    Parameters:
    
    updateAssetRequest - The request body for UpdateAsset.
    
    Returns:
    
    Result of the UpdateAsset operation returned by the service.
    
    Throws:
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - updateDataSet
```
UpdateDataSetResult updateDataSet(UpdateDataSetRequest updateDataSetRequest)
```
    This operation updates a data set.
    
    Parameters:
    
    updateDataSetRequest - The request body for UpdateDataSet.
    
    Returns:
    
    Result of the UpdateDataSet operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    See Also:
    
    AWS API Documentation
  - updateRevision
```
UpdateRevisionResult updateRevision(UpdateRevisionRequest updateRevisionRequest)
```
    This operation updates a revision.
    
    Parameters:
    
    updateRevisionRequest - The request body for UpdateRevision.
    
    Returns:
    
    Result of the UpdateRevision operation returned by the service.
    
    Throws:
    
    ValidationException - 400 response
    
    InternalServerException - 500 response
    
    AccessDeniedException - 403 response
    
    ResourceNotFoundException - 404 response
    
    ThrottlingException - 429 response
    
    ConflictException - 409 response
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSDataExchange

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

cancelJob

createDataSet

createJob

createRevision

deleteAsset

deleteDataSet

deleteRevision

getAsset

getDataSet

getJob

getRevision

listDataSetRevisions

listDataSets

listJobs

listRevisionAssets

listTagsForResource

startJob

tagResource

untagResource

updateAsset

updateDataSet

updateRevision

shutdown

getCachedResponseMetadata