AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.DataExchange

Inherits:
AWS.Service show all
Identifier:
dataexchange
API Version:
2017-07-25
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

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

Sending a Request Using DataExchange

var dataexchange = new AWS.DataExchange();
dataexchange.cancelJob(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DataExchange object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var dataexchange = new AWS.DataExchange({apiVersion: '2017-07-25'});

You can also set the API version globally in AWS.config.apiVersions using the dataexchange service identifier:

AWS.config.apiVersions = {
  dataexchange: '2017-07-25',
  // other service API versions
};

var dataexchange = new AWS.DataExchange();

Version:

  • 2017-07-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DataExchange(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DataExchange object

var dataexchange = new AWS.DataExchange({apiVersion: '2017-07-25'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.DataExchange.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.DataExchange.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.DataExchange.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the cancelJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
dataexchange.cancelJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The unique identifier for a job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createDataSet(params = {}, callback) ⇒ AWS.Request

This operation creates a data set.

Service Reference:

Examples:

Calling the createDataSet operation

var params = {
  AssetType: S3_SNAPSHOT, /* required */
  Description: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
dataexchange.createDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssetType — (String)

      The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

      Possible values include:
      • "S3_SNAPSHOT"
    • Description — (String)

      A description for the data set. This value can be up to 16,348 characters long.

    • Name — (String)

      The name of the data set.

    • Tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the data set.

      • AssetType — (String)

        The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

        Possible values include:
        • "S3_SNAPSHOT"
      • CreatedAt — (Date)

        The date and time that the data set was created, in ISO 8601 format.

      • Description — (String)

        The description for the data set.

      • Id — (String)

        The unique identifier for the data set.

      • Name — (String)

        The name of the data set.

      • Origin — (String)

        A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

        Possible values include:
        • "OWNED"
        • "ENTITLED"
      • OriginDetails — (map)

        If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

        • ProductIdrequired — (String)
      • SourceId — (String)

        The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

      • Tags — (map<String>)

        The tags for the data set.

      • UpdatedAt — (Date)

        The date and time that the data set was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createJob(params = {}, callback) ⇒ AWS.Request

This operation creates a job.

Service Reference:

Examples:

Calling the createJob operation

var params = {
  Details: { /* required */
    ExportAssetToSignedUrl: {
      AssetId: 'STRING_VALUE', /* required */
      DataSetId: 'STRING_VALUE', /* required */
      RevisionId: 'STRING_VALUE' /* required */
    },
    ExportAssetsToS3: {
      AssetDestinations: [ /* required */
        {
          AssetId: 'STRING_VALUE', /* required */
          Bucket: 'STRING_VALUE', /* required */
          Key: 'STRING_VALUE'
        },
        /* more items */
      ],
      DataSetId: 'STRING_VALUE', /* required */
      RevisionId: 'STRING_VALUE' /* required */
    },
    ImportAssetFromSignedUrl: {
      AssetName: 'STRING_VALUE', /* required */
      DataSetId: 'STRING_VALUE', /* required */
      Md5Hash: 'STRING_VALUE', /* required */
      RevisionId: 'STRING_VALUE' /* required */
    },
    ImportAssetsFromS3: {
      AssetSources: [ /* required */
        {
          Bucket: 'STRING_VALUE', /* required */
          Key: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      DataSetId: 'STRING_VALUE', /* required */
      RevisionId: 'STRING_VALUE' /* required */
    }
  },
  Type: IMPORT_ASSETS_FROM_S3 | IMPORT_ASSET_FROM_SIGNED_URL | EXPORT_ASSETS_TO_S3 | EXPORT_ASSET_TO_SIGNED_URL /* required */
};
dataexchange.createJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Details — (map)

      The details for the CreateJob request.

      • ExportAssetToSignedUrl — (map)

        Details about the export to signed URL request.

        • AssetIdrequired — (String)

          The unique identifier for the asset that is exported to a signed URL.

        • DataSetIdrequired — (String)

          The unique identifier for the data set associated with this export job.

        • RevisionIdrequired — (String)

          The unique identifier for the revision associated with this export request.

      • ExportAssetsToS3 — (map)

        Details about the export to Amazon S3 request.

        • AssetDestinationsrequired — (Array<map>)

          The destination for the asset.

          • AssetIdrequired — (String)

            The unique identifier for the asset.

          • Bucketrequired — (String)

            The S3 bucket that is the destination for the asset.

          • Key — (String)

            The name of the object in Amazon S3 for the asset.

        • DataSetIdrequired — (String)

          The unique identifier for the data set associated with this export job.

        • RevisionIdrequired — (String)

          The unique identifier for the revision associated with this export request.

      • ImportAssetFromSignedUrl — (map)

        Details about the import from signed URL request.

        • AssetNamerequired — (String)

          The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.

        • DataSetIdrequired — (String)

          The unique identifier for the data set associated with this import job.

        • Md5Hashrequired — (String)

          The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

        • RevisionIdrequired — (String)

          The unique identifier for the revision associated with this import request.

      • ImportAssetsFromS3 — (map)

        Details about the import from Amazon S3 request.

        • AssetSourcesrequired — (Array<map>)

          Is a list of S3 bucket and object key pairs.

          • Bucketrequired — (String)

            The S3 bucket that's part of the source of the asset.

          • Keyrequired — (String)

            The name of the object in Amazon S3 for the asset.

        • DataSetIdrequired — (String)

          The unique identifier for the data set associated with this import job.

        • RevisionIdrequired — (String)

          The unique identifier for the revision associated with this import request.

    • Type — (String)

      The type of job to be created.

      Possible values include:
      • "IMPORT_ASSETS_FROM_S3"
      • "IMPORT_ASSET_FROM_SIGNED_URL"
      • "EXPORT_ASSETS_TO_S3"
      • "EXPORT_ASSET_TO_SIGNED_URL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the job.

      • CreatedAt — (Date)

        The date and time that the job was created, in ISO 8601 format.

      • Details — (map)

        Details about the job.

        • ExportAssetToSignedUrl — (map)

          Details for the export to signed URL response.

          • AssetIdrequired — (String)

            The unique identifier for the asset associated with this export job.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this export job.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this export response.

          • SignedUrl — (String)

            The signed URL for the export request.

          • SignedUrlExpiresAt — (Date)

            The date and time that the signed URL expires, in ISO 8601 format.

        • ExportAssetsToS3 — (map)

          Details for the export to Amazon S3 response.

          • AssetDestinationsrequired — (Array<map>)

            The destination in Amazon S3 where the asset is exported.

            • AssetIdrequired — (String)

              The unique identifier for the asset.

            • Bucketrequired — (String)

              The S3 bucket that is the destination for the asset.

            • Key — (String)

              The name of the object in Amazon S3 for the asset.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this export job.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this export response.

        • ImportAssetFromSignedUrl — (map)

          Details for the import from signed URL response.

          • AssetNamerequired — (String)

            The name for the asset associated with this import response.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this import job.

          • Md5Hash — (String)

            The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this import response.

          • SignedUrl — (String)

            The signed URL.

          • SignedUrlExpiresAt — (Date)

            The time and date at which the signed URL expires, in ISO 8601 format.

        • ImportAssetsFromS3 — (map)

          Details for the import from Amazon S3 response.

          • AssetSourcesrequired — (Array<map>)

            Is a list of Amazon S3 bucket and object key pairs.

            • Bucketrequired — (String)

              The S3 bucket that's part of the source of the asset.

            • Keyrequired — (String)

              The name of the object in Amazon S3 for the asset.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this import job.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this import response.

      • Errors — (Array<map>)

        The errors associated with jobs.

        • Coderequired — (String) The code for the job error. Possible values include:
          • "ACCESS_DENIED_EXCEPTION"
          • "INTERNAL_SERVER_EXCEPTION"
          • "MALWARE_DETECTED"
          • "RESOURCE_NOT_FOUND_EXCEPTION"
          • "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
          • "VALIDATION_EXCEPTION"
          • "MALWARE_SCAN_ENCRYPTED_FILE"
        • Details — (map)
          • ImportAssetFromSignedUrlJobErrorDetails — (map)
            • AssetNamerequired — (String)

              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.

          • ImportAssetsFromS3JobErrorDetails — (Array<map>)

            The list of sources for the assets.

            • Bucketrequired — (String)

              The S3 bucket that's part of the source of the asset.

            • Keyrequired — (String)

              The name of the object in Amazon S3 for the asset.

        • LimitName — (String)

          The name of the limit that was reached.

          Possible values include:
          • "Assets per revision"
          • "Asset size in GB"
        • LimitValue — (Float) The value of the exceeded limit.
        • Messagerequired — (String) The message related to the job error.
        • ResourceId — (String) The unqiue identifier for the resource related to the error.
        • ResourceType — (String) The type of resource related to the error. Possible values include:
          • "REVISION"
          • "ASSET"
      • Id — (String)

        The unique identifier for the job.

      • State — (String)

        The state of the job.

        Possible values include:
        • "WAITING"
        • "IN_PROGRESS"
        • "ERROR"
        • "COMPLETED"
        • "CANCELLED"
        • "TIMED_OUT"
      • Type — (String)

        The job type.

        Possible values include:
        • "IMPORT_ASSETS_FROM_S3"
        • "IMPORT_ASSET_FROM_SIGNED_URL"
        • "EXPORT_ASSETS_TO_S3"
        • "EXPORT_ASSET_TO_SIGNED_URL"
      • UpdatedAt — (Date)

        The date and time that the job was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createRevision(params = {}, callback) ⇒ AWS.Request

This operation creates a revision for a data set.

Service Reference:

Examples:

Calling the createRevision operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  Comment: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
dataexchange.createRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Comment — (String)

      An optional comment about the revision.

    • DataSetId — (String)

      The unique identifier for a data set.

    • Tags — (map<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the revision

      • Comment — (String)

        An optional comment about the revision.

      • CreatedAt — (Date)

        The date and time that the revision was created, in ISO 8601 format.

      • DataSetId — (String)

        The unique identifier for the data set associated with this revision.

      • Finalized — (Boolean)

        To publish a revision to a data set in a product, the revision must first be 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.

        Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

      • Id — (String)

        The unique identifier for the revision.

      • SourceId — (String)

        The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

      • Tags — (map<String>)

        The tags for the revision.

      • UpdatedAt — (Date)

        The date and time that the revision was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAsset(params = {}, callback) ⇒ AWS.Request

This operation deletes an asset.

Service Reference:

Examples:

Calling the deleteAsset operation

var params = {
  AssetId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  RevisionId: 'STRING_VALUE' /* required */
};
dataexchange.deleteAsset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssetId — (String)

      The unique identifier for an asset.

    • DataSetId — (String)

      The unique identifier for a data set.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteDataSet(params = {}, callback) ⇒ AWS.Request

This operation deletes a data set.

Service Reference:

Examples:

Calling the deleteDataSet operation

var params = {
  DataSetId: 'STRING_VALUE' /* required */
};
dataexchange.deleteDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRevision(params = {}, callback) ⇒ AWS.Request

This operation deletes a revision.

Service Reference:

Examples:

Calling the deleteRevision operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  RevisionId: 'STRING_VALUE' /* required */
};
dataexchange.deleteRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAsset(params = {}, callback) ⇒ AWS.Request

This operation returns information about an asset.

Service Reference:

Examples:

Calling the getAsset operation

var params = {
  AssetId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  RevisionId: 'STRING_VALUE' /* required */
};
dataexchange.getAsset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssetId — (String)

      The unique identifier for an asset.

    • DataSetId — (String)

      The unique identifier for a data set.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the asset.

      • AssetDetails — (map)

        Information about the asset, including its size.

        • S3SnapshotAsset — (map)

          The S3 object that is the asset.

          • Sizerequired — (Float)

            The size of the S3 object that is the object.

      • AssetType — (String)

        The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

        Possible values include:
        • "S3_SNAPSHOT"
      • CreatedAt — (Date)

        The date and time that the asset was created, in ISO 8601 format.

      • DataSetId — (String)

        The unique identifier for the data set associated with this asset.

      • Id — (String)

        The unique identifier for the asset.

      • Name — (String)

        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.

      • RevisionId — (String)

        The unique identifier for the revision associated with this asset.

      • SourceId — (String)

        The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

      • UpdatedAt — (Date)

        The date and time that the asset was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getDataSet(params = {}, callback) ⇒ AWS.Request

This operation returns information about a data set.

Service Reference:

Examples:

Calling the getDataSet operation

var params = {
  DataSetId: 'STRING_VALUE' /* required */
};
dataexchange.getDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the data set.

      • AssetType — (String)

        The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

        Possible values include:
        • "S3_SNAPSHOT"
      • CreatedAt — (Date)

        The date and time that the data set was created, in ISO 8601 format.

      • Description — (String)

        The description for the data set.

      • Id — (String)

        The unique identifier for the data set.

      • Name — (String)

        The name of the data set.

      • Origin — (String)

        A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

        Possible values include:
        • "OWNED"
        • "ENTITLED"
      • OriginDetails — (map)

        If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

        • ProductIdrequired — (String)
      • SourceId — (String)

        The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

      • Tags — (map<String>)

        The tags for the data set.

      • UpdatedAt — (Date)

        The date and time that the data set was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getJob(params = {}, callback) ⇒ AWS.Request

This operation returns information about a job.

Service Reference:

Examples:

Calling the getJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
dataexchange.getJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The unique identifier for a job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the job.

      • CreatedAt — (Date)

        The date and time that the job was created, in ISO 8601 format.

      • Details — (map)

        Details about the job.

        • ExportAssetToSignedUrl — (map)

          Details for the export to signed URL response.

          • AssetIdrequired — (String)

            The unique identifier for the asset associated with this export job.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this export job.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this export response.

          • SignedUrl — (String)

            The signed URL for the export request.

          • SignedUrlExpiresAt — (Date)

            The date and time that the signed URL expires, in ISO 8601 format.

        • ExportAssetsToS3 — (map)

          Details for the export to Amazon S3 response.

          • AssetDestinationsrequired — (Array<map>)

            The destination in Amazon S3 where the asset is exported.

            • AssetIdrequired — (String)

              The unique identifier for the asset.

            • Bucketrequired — (String)

              The S3 bucket that is the destination for the asset.

            • Key — (String)

              The name of the object in Amazon S3 for the asset.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this export job.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this export response.

        • ImportAssetFromSignedUrl — (map)

          Details for the import from signed URL response.

          • AssetNamerequired — (String)

            The name for the asset associated with this import response.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this import job.

          • Md5Hash — (String)

            The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this import response.

          • SignedUrl — (String)

            The signed URL.

          • SignedUrlExpiresAt — (Date)

            The time and date at which the signed URL expires, in ISO 8601 format.

        • ImportAssetsFromS3 — (map)

          Details for the import from Amazon S3 response.

          • AssetSourcesrequired — (Array<map>)

            Is a list of Amazon S3 bucket and object key pairs.

            • Bucketrequired — (String)

              The S3 bucket that's part of the source of the asset.

            • Keyrequired — (String)

              The name of the object in Amazon S3 for the asset.

          • DataSetIdrequired — (String)

            The unique identifier for the data set associated with this import job.

          • RevisionIdrequired — (String)

            The unique identifier for the revision associated with this import response.

      • Errors — (Array<map>)

        The errors associated with jobs.

        • Coderequired — (String) The code for the job error. Possible values include:
          • "ACCESS_DENIED_EXCEPTION"
          • "INTERNAL_SERVER_EXCEPTION"
          • "MALWARE_DETECTED"
          • "RESOURCE_NOT_FOUND_EXCEPTION"
          • "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
          • "VALIDATION_EXCEPTION"
          • "MALWARE_SCAN_ENCRYPTED_FILE"
        • Details — (map)
          • ImportAssetFromSignedUrlJobErrorDetails — (map)
            • AssetNamerequired — (String)

              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.

          • ImportAssetsFromS3JobErrorDetails — (Array<map>)

            The list of sources for the assets.

            • Bucketrequired — (String)

              The S3 bucket that's part of the source of the asset.

            • Keyrequired — (String)

              The name of the object in Amazon S3 for the asset.

        • LimitName — (String)

          The name of the limit that was reached.

          Possible values include:
          • "Assets per revision"
          • "Asset size in GB"
        • LimitValue — (Float) The value of the exceeded limit.
        • Messagerequired — (String) The message related to the job error.
        • ResourceId — (String) The unqiue identifier for the resource related to the error.
        • ResourceType — (String) The type of resource related to the error. Possible values include:
          • "REVISION"
          • "ASSET"
      • Id — (String)

        The unique identifier for the job.

      • State — (String)

        The state of the job.

        Possible values include:
        • "WAITING"
        • "IN_PROGRESS"
        • "ERROR"
        • "COMPLETED"
        • "CANCELLED"
        • "TIMED_OUT"
      • Type — (String)

        The job type.

        Possible values include:
        • "IMPORT_ASSETS_FROM_S3"
        • "IMPORT_ASSET_FROM_SIGNED_URL"
        • "EXPORT_ASSETS_TO_S3"
        • "EXPORT_ASSET_TO_SIGNED_URL"
      • UpdatedAt — (Date)

        The date and time that the job was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRevision(params = {}, callback) ⇒ AWS.Request

This operation returns information about a revision.

Service Reference:

Examples:

Calling the getRevision operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  RevisionId: 'STRING_VALUE' /* required */
};
dataexchange.getRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the revision

      • Comment — (String)

        An optional comment about the revision.

      • CreatedAt — (Date)

        The date and time that the revision was created, in ISO 8601 format.

      • DataSetId — (String)

        The unique identifier for the data set associated with this revision.

      • Finalized — (Boolean)

        To publish a revision to a data set in a product, the revision must first be 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.

        Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

      • Id — (String)

        The unique identifier for the revision.

      • SourceId — (String)

        The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

      • Tags — (map<String>)

        The tags for the revision.

      • UpdatedAt — (Date)

        The date and time that the revision was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataSetRevisions(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listDataSetRevisions operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
dataexchange.listDataSetRevisions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

    • MaxResults — (Integer)

      The maximum number of results returned by a single call.

    • NextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The token value retrieved from a previous call to access the next page of results.

      • Revisions — (Array<map>)

        The asset objects listed by the request.

        • Arnrequired — (String)

          The ARN for the revision.

        • Comment — (String)

          An optional comment about the revision.

        • CreatedAtrequired — (Date)

          The date and time that the revision was created, in ISO 8601 format.

        • DataSetIdrequired — (String)

          The unique identifier for the data set associated with this revision.

        • Finalized — (Boolean)

          To publish a revision to a data set in a product, the revision must first be 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.

          Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

        • Idrequired — (String)

          The unique identifier for the revision.

        • SourceId — (String)

          The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

        • UpdatedAtrequired — (Date)

          The date and time that the revision was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listDataSets(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listDataSets operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Origin: 'STRING_VALUE'
};
dataexchange.listDataSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The maximum number of results returned by a single call.

    • NextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

    • Origin — (String)

      A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataSets — (Array<map>)

        The data set objects listed by the request.

        • Arnrequired — (String)

          The ARN for the data set.

        • AssetTyperequired — (String)

          The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

          Possible values include:
          • "S3_SNAPSHOT"
        • CreatedAtrequired — (Date)

          The date and time that the data set was created, in ISO 8601 format.

        • Descriptionrequired — (String)

          The description for the data set.

        • Idrequired — (String)

          The unique identifier for the data set.

        • Namerequired — (String)

          The name of the data set.

        • Originrequired — (String)

          A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

          Possible values include:
          • "OWNED"
          • "ENTITLED"
        • OriginDetails — (map)

          If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

          • ProductIdrequired — (String)
        • SourceId — (String)

          The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

        • UpdatedAtrequired — (Date)

          The date and time that the data set was last updated, in ISO 8601 format.

      • NextToken — (String)

        The token value retrieved from a previous call to access the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listJobs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listJobs operation

var params = {
  DataSetId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  RevisionId: 'STRING_VALUE'
};
dataexchange.listJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

    • MaxResults — (Integer)

      The maximum number of results returned by a single call.

    • NextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Jobs — (Array<map>)

        The jobs listed by the request.

        • Arnrequired — (String)

          The ARN for the job.

        • CreatedAtrequired — (Date)

          The date and time that the job was created, in ISO 8601 format.

        • Detailsrequired — (map)

          Details of the operation to be performed by the job, such as export destination details or import source details.

          • ExportAssetToSignedUrl — (map)

            Details for the export to signed URL response.

            • AssetIdrequired — (String)

              The unique identifier for the asset associated with this export job.

            • DataSetIdrequired — (String)

              The unique identifier for the data set associated with this export job.

            • RevisionIdrequired — (String)

              The unique identifier for the revision associated with this export response.

            • SignedUrl — (String)

              The signed URL for the export request.

            • SignedUrlExpiresAt — (Date)

              The date and time that the signed URL expires, in ISO 8601 format.

          • ExportAssetsToS3 — (map)

            Details for the export to Amazon S3 response.

            • AssetDestinationsrequired — (Array<map>)

              The destination in Amazon S3 where the asset is exported.

              • AssetIdrequired — (String)

                The unique identifier for the asset.

              • Bucketrequired — (String)

                The S3 bucket that is the destination for the asset.

              • Key — (String)

                The name of the object in Amazon S3 for the asset.

            • DataSetIdrequired — (String)

              The unique identifier for the data set associated with this export job.

            • RevisionIdrequired — (String)

              The unique identifier for the revision associated with this export response.

          • ImportAssetFromSignedUrl — (map)

            Details for the import from signed URL response.

            • AssetNamerequired — (String)

              The name for the asset associated with this import response.

            • DataSetIdrequired — (String)

              The unique identifier for the data set associated with this import job.

            • Md5Hash — (String)

              The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.

            • RevisionIdrequired — (String)

              The unique identifier for the revision associated with this import response.

            • SignedUrl — (String)

              The signed URL.

            • SignedUrlExpiresAt — (Date)

              The time and date at which the signed URL expires, in ISO 8601 format.

          • ImportAssetsFromS3 — (map)

            Details for the import from Amazon S3 response.

            • AssetSourcesrequired — (Array<map>)

              Is a list of Amazon S3 bucket and object key pairs.

              • Bucketrequired — (String)

                The S3 bucket that's part of the source of the asset.

              • Keyrequired — (String)

                The name of the object in Amazon S3 for the asset.

            • DataSetIdrequired — (String)

              The unique identifier for the data set associated with this import job.

            • RevisionIdrequired — (String)

              The unique identifier for the revision associated with this import response.

        • Errors — (Array<map>)

          Errors for jobs.

          • Coderequired — (String) The code for the job error. Possible values include:
            • "ACCESS_DENIED_EXCEPTION"
            • "INTERNAL_SERVER_EXCEPTION"
            • "MALWARE_DETECTED"
            • "RESOURCE_NOT_FOUND_EXCEPTION"
            • "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
            • "VALIDATION_EXCEPTION"
            • "MALWARE_SCAN_ENCRYPTED_FILE"
          • Details — (map)
            • ImportAssetFromSignedUrlJobErrorDetails — (map)
              • AssetNamerequired — (String)

                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.

            • ImportAssetsFromS3JobErrorDetails — (Array<map>)

              The list of sources for the assets.

              • Bucketrequired — (String)

                The S3 bucket that's part of the source of the asset.

              • Keyrequired — (String)

                The name of the object in Amazon S3 for the asset.

          • LimitName — (String)

            The name of the limit that was reached.

            Possible values include:
            • "Assets per revision"
            • "Asset size in GB"
          • LimitValue — (Float) The value of the exceeded limit.
          • Messagerequired — (String) The message related to the job error.
          • ResourceId — (String) The unqiue identifier for the resource related to the error.
          • ResourceType — (String) The type of resource related to the error. Possible values include:
            • "REVISION"
            • "ASSET"
        • Idrequired — (String)

          The unique identifier for the job.

        • Staterequired — (String)

          The state of the job.

          Possible values include:
          • "WAITING"
          • "IN_PROGRESS"
          • "ERROR"
          • "COMPLETED"
          • "CANCELLED"
          • "TIMED_OUT"
        • Typerequired — (String)

          The job type.

          Possible values include:
          • "IMPORT_ASSETS_FROM_S3"
          • "IMPORT_ASSET_FROM_SIGNED_URL"
          • "EXPORT_ASSETS_TO_S3"
          • "EXPORT_ASSET_TO_SIGNED_URL"
        • UpdatedAtrequired — (Date)

          The date and time that the job was last updated, in ISO 8601 format.

      • NextToken — (String)

        The token value retrieved from a previous call to access the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRevisionAssets(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listRevisionAssets operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  RevisionId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
dataexchange.listRevisionAssets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

    • MaxResults — (Integer)

      The maximum number of results returned by a single call.

    • NextToken — (String)

      The token value retrieved from a previous call to access the next page of results.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Assets — (Array<map>)

        The asset objects listed by the request.

        • Arnrequired — (String)

          The ARN for the asset.

        • AssetDetailsrequired — (map)

          Information about the asset, including its size.

          • S3SnapshotAsset — (map)

            The S3 object that is the asset.

            • Sizerequired — (Float)

              The size of the S3 object that is the object.

        • AssetTyperequired — (String)

          The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

          Possible values include:
          • "S3_SNAPSHOT"
        • CreatedAtrequired — (Date)

          The date and time that the asset was created, in ISO 8601 format.

        • DataSetIdrequired — (String)

          The unique identifier for the data set associated with this asset.

        • Idrequired — (String)

          The unique identifier for the asset.

        • Namerequired — (String)

          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.

        • RevisionIdrequired — (String)

          The unique identifier for the revision associated with this asset.

        • SourceId — (String)

          The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

        • UpdatedAtrequired — (Date)

          The date and time that the asset was last updated, in ISO 8601 format.

      • NextToken — (String)

        The token value retrieved from a previous call to access the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

This operation lists the tags on the resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
dataexchange.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>) A label that consists of a customer-defined key and an optional value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startJob(params = {}, callback) ⇒ AWS.Request

This operation starts a job.

Service Reference:

Examples:

Calling the startJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
dataexchange.startJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The unique identifier for a job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

This operation tags a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
dataexchange.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

    • Tags — (map<String>) A label that consists of a customer-defined key and an optional value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

This operation removes one or more tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
dataexchange.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.

    • TagKeys — (Array<String>) The key tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAsset(params = {}, callback) ⇒ AWS.Request

This operation updates an asset.

Service Reference:

Examples:

Calling the updateAsset operation

var params = {
  AssetId: 'STRING_VALUE', /* required */
  DataSetId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  RevisionId: 'STRING_VALUE' /* required */
};
dataexchange.updateAsset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AssetId — (String)

      The unique identifier for an asset.

    • DataSetId — (String)

      The unique identifier for a data set.

    • Name — (String)

      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.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the asset.

      • AssetDetails — (map)

        Information about the asset, including its size.

        • S3SnapshotAsset — (map)

          The S3 object that is the asset.

          • Sizerequired — (Float)

            The size of the S3 object that is the object.

      • AssetType — (String)

        The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

        Possible values include:
        • "S3_SNAPSHOT"
      • CreatedAt — (Date)

        The date and time that the asset was created, in ISO 8601 format.

      • DataSetId — (String)

        The unique identifier for the data set associated with this asset.

      • Id — (String)

        The unique identifier for the asset.

      • Name — (String)

        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.

      • RevisionId — (String)

        The unique identifier for the revision associated with this asset.

      • SourceId — (String)

        The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.

      • UpdatedAt — (Date)

        The date and time that the asset was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateDataSet(params = {}, callback) ⇒ AWS.Request

This operation updates a data set.

Service Reference:

Examples:

Calling the updateDataSet operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
dataexchange.updateDataSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • DataSetId — (String)

      The unique identifier for a data set.

    • Description — (String)

      The description for the data set.

    • Name — (String)

      The name of the data set.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the data set.

      • AssetType — (String)

        The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

        Possible values include:
        • "S3_SNAPSHOT"
      • CreatedAt — (Date)

        The date and time that the data set was created, in ISO 8601 format.

      • Description — (String)

        The description for the data set.

      • Id — (String)

        The unique identifier for the data set.

      • Name — (String)

        The name of the data set.

      • Origin — (String)

        A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

        Possible values include:
        • "OWNED"
        • "ENTITLED"
      • OriginDetails — (map)

        If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

        • ProductIdrequired — (String)
      • SourceId — (String)

        The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

      • UpdatedAt — (Date)

        The date and time that the data set was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateRevision(params = {}, callback) ⇒ AWS.Request

This operation updates a revision.

Service Reference:

Examples:

Calling the updateRevision operation

var params = {
  DataSetId: 'STRING_VALUE', /* required */
  RevisionId: 'STRING_VALUE', /* required */
  Comment: 'STRING_VALUE',
  Finalized: true || false
};
dataexchange.updateRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Comment — (String)

      An optional comment about the revision.

    • DataSetId — (String)

      The unique identifier for a data set.

    • Finalized — (Boolean)

      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.

    • RevisionId — (String)

      The unique identifier for a revision.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String)

        The ARN for the revision.

      • Comment — (String)

        An optional comment about the revision.

      • CreatedAt — (Date)

        The date and time that the revision was created, in ISO 8601 format.

      • DataSetId — (String)

        The unique identifier for the data set associated with this revision.

      • Finalized — (Boolean)

        To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that 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.

        Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

      • Id — (String)

        The unique identifier for the revision.

      • SourceId — (String)

        The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is returned when a revision owner is viewing the entitled copy of its owned revision.

      • UpdatedAt — (Date)

        The date and time that the revision was last updated, in ISO 8601 format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.