The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::DataExchange - Perl Interface to AWS AWS Data Exchange

SYNOPSIS

  use Paws;

  my $obj = Paws->service('DataExchange');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/dataexchange-2017-07-25

METHODS

CancelJob

JobId => Str

Each argument is described in detail in: Paws::DataExchange::CancelJob

Returns: nothing

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

CreateDataSet

AssetType => Str
Description => Str
Name => Str
[Tags => Paws::DataExchange::MapOf__string]

Each argument is described in detail in: Paws::DataExchange::CreateDataSet

Returns: a Paws::DataExchange::CreateDataSetResponse instance

This operation creates a data set.

CreateJob

Details => Paws::DataExchange::RequestDetails
Type => Str

Each argument is described in detail in: Paws::DataExchange::CreateJob

Returns: a Paws::DataExchange::CreateJobResponse instance

This operation creates a job.

CreateRevision

DataSetId => Str
[Comment => Str]
[Tags => Paws::DataExchange::MapOf__string]

Each argument is described in detail in: Paws::DataExchange::CreateRevision

Returns: a Paws::DataExchange::CreateRevisionResponse instance

This operation creates a revision for a data set.

DeleteAsset

AssetId => Str
DataSetId => Str
RevisionId => Str

Each argument is described in detail in: Paws::DataExchange::DeleteAsset

Returns: nothing

This operation deletes an asset.

DeleteDataSet

DataSetId => Str

Each argument is described in detail in: Paws::DataExchange::DeleteDataSet

Returns: nothing

This operation deletes a data set.

DeleteRevision

DataSetId => Str
RevisionId => Str

Each argument is described in detail in: Paws::DataExchange::DeleteRevision

Returns: nothing

This operation deletes a revision.

GetAsset

AssetId => Str
DataSetId => Str
RevisionId => Str

Each argument is described in detail in: Paws::DataExchange::GetAsset

Returns: a Paws::DataExchange::GetAssetResponse instance

This operation returns information about an asset.

GetDataSet

DataSetId => Str

Each argument is described in detail in: Paws::DataExchange::GetDataSet

Returns: a Paws::DataExchange::GetDataSetResponse instance

This operation returns information about a data set.

GetJob

JobId => Str

Each argument is described in detail in: Paws::DataExchange::GetJob

Returns: a Paws::DataExchange::GetJobResponse instance

This operation returns information about a job.

GetRevision

DataSetId => Str
RevisionId => Str

Each argument is described in detail in: Paws::DataExchange::GetRevision

Returns: a Paws::DataExchange::GetRevisionResponse instance

This operation returns information about a revision.

ListDataSetRevisions

DataSetId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DataExchange::ListDataSetRevisions

Returns: a Paws::DataExchange::ListDataSetRevisionsResponse instance

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

ListDataSets

[MaxResults => Int]
[NextToken => Str]
[Origin => Str]

Each argument is described in detail in: Paws::DataExchange::ListDataSets

Returns: a Paws::DataExchange::ListDataSetsResponse instance

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.

ListJobs

[DataSetId => Str]
[MaxResults => Int]
[NextToken => Str]
[RevisionId => Str]

Each argument is described in detail in: Paws::DataExchange::ListJobs

Returns: a Paws::DataExchange::ListJobsResponse instance

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

ListRevisionAssets

DataSetId => Str
RevisionId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DataExchange::ListRevisionAssets

Returns: a Paws::DataExchange::ListRevisionAssetsResponse instance

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

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::DataExchange::ListTagsForResource

Returns: a Paws::DataExchange::ListTagsForResourceResponse instance

This operation lists the tags on the resource.

StartJob

JobId => Str

Each argument is described in detail in: Paws::DataExchange::StartJob

Returns: a Paws::DataExchange::StartJobResponse instance

This operation starts a job.

TagResource

ResourceArn => Str
Tags => Paws::DataExchange::MapOf__string

Each argument is described in detail in: Paws::DataExchange::TagResource

Returns: nothing

This operation tags a resource.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::DataExchange::UntagResource

Returns: nothing

This operation removes one or more tags from a resource.

UpdateAsset

AssetId => Str
DataSetId => Str
Name => Str
RevisionId => Str

Each argument is described in detail in: Paws::DataExchange::UpdateAsset

Returns: a Paws::DataExchange::UpdateAssetResponse instance

This operation updates an asset.

UpdateDataSet

DataSetId => Str
[Description => Str]
[Name => Str]

Each argument is described in detail in: Paws::DataExchange::UpdateDataSet

Returns: a Paws::DataExchange::UpdateDataSetResponse instance

This operation updates a data set.

UpdateRevision

DataSetId => Str
RevisionId => Str
[Comment => Str]
[Finalized => Bool]

Each argument is described in detail in: Paws::DataExchange::UpdateRevision

Returns: a Paws::DataExchange::UpdateRevisionResponse instance

This operation updates a revision.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllDataSetRevisions(sub { },DataSetId => Str, [MaxResults => Int, NextToken => Str])

ListAllDataSetRevisions(DataSetId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Revisions, passing the object as the first parameter, and the string 'Revisions' as the second parameter 

If not, it will return a a Paws::DataExchange::ListDataSetRevisionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllDataSets(sub { },[MaxResults => Int, NextToken => Str, Origin => Str])

ListAllDataSets([MaxResults => Int, NextToken => Str, Origin => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - DataSets, passing the object as the first parameter, and the string 'DataSets' as the second parameter 

If not, it will return a a Paws::DataExchange::ListDataSetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllJobs(sub { },[DataSetId => Str, MaxResults => Int, NextToken => Str, RevisionId => Str])

ListAllJobs([DataSetId => Str, MaxResults => Int, NextToken => Str, RevisionId => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter 

If not, it will return a a Paws::DataExchange::ListJobsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllRevisionAssets(sub { },DataSetId => Str, RevisionId => Str, [MaxResults => Int, NextToken => Str])

ListAllRevisionAssets(DataSetId => Str, RevisionId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Assets, passing the object as the first parameter, and the string 'Assets' as the second parameter 

If not, it will return a a Paws::DataExchange::ListRevisionAssetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues