Class: AWS.DataZone

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  decisionComment: 'STRING_VALUE'
};
datazone.acceptSubscriptionRequest(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: {}) —
  • decisionComment — (String)

    A description that specifies the reason for accepting the specified subscription request.

  • domainIdentifier — (String)

    The Amazon DataZone domain where the specified subscription request is being accepted.

  • identifier — (String)

    The unique identifier of the subscription request that is to be accepted.

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:

    • createdAt — (Date)

      The timestamp that specifies when the subscription request was accepted.

    • createdBy — (String)

      Specifies the Amazon DataZone user that accepted the specified subscription request.

    • decisionComment — (String)

      Specifies the reason for accepting the subscription request.

    • domainId — (String)

      The unique identifier of the Amazon DataZone domain where the specified subscription request was accepted.

    • id — (String)

      The identifier of the subscription request.

    • requestReason — (String)

      Specifies the reason for requesting a subscription to the asset.

    • reviewerId — (String)

      Specifes the ID of the Amazon DataZone user who reviewed the subscription request.

    • status — (String)

      Specifies the status of the subscription request.

      Possible values include:
      • "PENDING"
      • "ACCEPTED"
      • "REJECTED"
    • subscribedListings — (Array<map>)

      Specifies the asset for which the subscription request was created.

      • description — required — (String)

        The description of the published asset for which the subscription grant is created.

      • id — required — (String)

        The identifier of the published asset for which the subscription grant is created.

      • item — required — (map)

        The published asset for which the subscription grant is created.

        • assetListing — (map)

          The asset for which the subscription grant is created.

          • entityId — (String)

            The identifier of the published asset for which the subscription grant is created.

          • entityRevision — (String)

            The revision of the published asset for which the subscription grant is created.

          • entityType — (String)

            The type of the published asset for which the subscription grant is created.

          • forms — (String)

            The forms attached to the published asset for which the subscription grant is created.

          • glossaryTerms — (Array<map>)

            The glossary terms attached to the published asset for which the subscription grant is created.

            • name — (String)

              The name of a glossary term attached to the inventory asset.

            • shortDescription — (String)

              The shoft description of a glossary term attached to the inventory asset.

      • name — required — (String)

        The name of the published asset for which the subscription grant is created.

      • ownerProjectId — required — (String)

        The identifier of the project of the published asset for which the subscription grant is created.

      • ownerProjectName — (String)

        The name of the project that owns the published asset for which the subscription grant is created.

      • revision — (String)

        The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipals — (Array<map>)

      Specifies the Amazon DataZone users who are subscribed to the asset specified in the subscription request.

      • project — (map)

        The project that has the subscription grant.

        • id — (String)

          The identifier of the project that has the subscription grant.

        • name — (String)

          The name of the project that has the subscription grant.

    • updatedAt — (Date)

      Specifies the timestamp when subscription request was updated.

    • updatedBy — (String)

      Specifies the Amazon DataZone user who updated the subscription request.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.cancelMetadataGenerationRun(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the metadata generation run is to be cancelled.

  • identifier — (String)

    The ID of the metadata generation run.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.cancelSubscription(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: {}) —
  • domainIdentifier — (String)

    The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.

  • identifier — (String)

    The unique identifier of the subscription that is being cancelled.

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:

    • createdAt — (Date)

      The timestamp that specifies when the request to cancel the subscription was created.

    • createdBy — (String)

      Specifies the Amazon DataZone user who is cancelling the subscription.

    • domainId — (String)

      The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.

    • id — (String)

      The identifier of the subscription.

    • retainPermissions — (Boolean)

      Specifies whether the permissions to the asset are retained after the subscription is cancelled.

    • status — (String)

      The status of the request to cancel the subscription.

      Possible values include:
      • "APPROVED"
      • "REVOKED"
      • "CANCELLED"
    • subscribedListing — (map)

      The asset to which a subscription is being cancelled.

      • description — required — (String)

        The description of the published asset for which the subscription grant is created.

      • id — required — (String)

        The identifier of the published asset for which the subscription grant is created.

      • item — required — (map)

        The published asset for which the subscription grant is created.

        • assetListing — (map)

          The asset for which the subscription grant is created.

          • entityId — (String)

            The identifier of the published asset for which the subscription grant is created.

          • entityRevision — (String)

            The revision of the published asset for which the subscription grant is created.

          • entityType — (String)

            The type of the published asset for which the subscription grant is created.

          • forms — (String)

            The forms attached to the published asset for which the subscription grant is created.

          • glossaryTerms — (Array<map>)

            The glossary terms attached to the published asset for which the subscription grant is created.

            • name — (String)

              The name of a glossary term attached to the inventory asset.

            • shortDescription — (String)

              The shoft description of a glossary term attached to the inventory asset.

      • name — required — (String)

        The name of the published asset for which the subscription grant is created.

      • ownerProjectId — required — (String)

        The identifier of the project of the published asset for which the subscription grant is created.

      • ownerProjectName — (String)

        The name of the project that owns the published asset for which the subscription grant is created.

      • revision — (String)

        The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipal — (map)

      The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.

      • project — (map)

        The project that has the subscription grant.

        • id — (String)

          The identifier of the project that has the subscription grant.

        • name — (String)

          The name of the project that has the subscription grant.

    • subscriptionRequestId — (String)

      The unique ID of the subscripton request for the subscription that is being cancelled.

    • updatedAt — (Date)

      The timestamp that specifies when the subscription was cancelled.

    • updatedBy — (String)

      The Amazon DataZone user that cancelled the subscription.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  owningProjectIdentifier: 'STRING_VALUE', /* required */
  typeIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  externalIdentifier: 'STRING_VALUE',
  formsInput: [
    {
      formName: 'STRING_VALUE', /* required */
      content: 'STRING_VALUE',
      typeIdentifier: 'STRING_VALUE',
      typeRevision: 'STRING_VALUE'
    },
    /* more items */
  ],
  glossaryTerms: [
    'STRING_VALUE',
    /* more items */
  ],
  predictionConfiguration: {
    businessNameGeneration: {
      enabled: true || false
    }
  },
  typeRevision: 'STRING_VALUE'
};
datazone.createAsset(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    Asset description.

  • domainIdentifier — (String)

    Amazon DataZone domain where the asset is created.

  • externalIdentifier — (String)

    The external identifier of the asset.

  • formsInput — (Array<map>)

    Metadata forms attached to the asset.

    • content — (String)

      The content of the metadata form.

    • formName — required — (String)

      The name of the metadata form.

    • typeIdentifier — (String)

      The ID of the metadata form type.

    • typeRevision — (String)

      The revision of the metadata form type.

  • glossaryTerms — (Array<String>)

    Glossary terms attached to the asset.

  • name — (String)

    Asset name.

  • owningProjectIdentifier — (String)

    The unique identifier of the project that owns this asset.

  • predictionConfiguration — (map)

    The configuration of the automatically generated business-friendly metadata for the asset.

    • businessNameGeneration — (map)

      The business name generation mechanism.

      • enabled — (Boolean)

        Specifies whether the business name generation is enabled.

  • typeIdentifier — (String)

    The unique identifier of this asset's type.

  • typeRevision — (String)

    The revision of this asset's type.

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:

    • createdAt — (Date)

      The timestamp of when the asset was created.

    • createdBy — (String)

      The Amazon DataZone user that created this asset in the catalog.

    • description — (String)

      The description of the created asset.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which the asset was created.

    • externalIdentifier — (String)

      The external identifier of the asset.

    • firstRevisionCreatedAt — (Date)

      The timestamp of when the first revision of the asset took place.

    • firstRevisionCreatedBy — (String)

      The Amazon DataZone user that made the first revision of the asset.

    • formsOutput — (Array<map>)

      The metadata forms that are attached to the created asset.

      • content — (String)

        The content of the metadata form.

      • formName — required — (String)

        The name of the metadata form.

      • typeName — (String)

        The name of the metadata form type.

      • typeRevision — (String)

        The revision of the metadata form type.

    • glossaryTerms — (Array<String>)

      The glossary terms that are attached to the created asset.

    • id — (String)

      The unique identifier of the created asset.

    • latestTimeSeriesDataPointFormsOutput — (Array<map>)

      The latest data point that was imported into the time series form for the asset.

      • contentSummary — (String)

        The content of the summary of the time series data points form.

      • formName — required — (String)

        The name of the time series data points summary form.

      • id — (String)

        The ID of the time series data points summary form.

      • timestamp — required — (Date)

        The timestamp of the time series data points summary form.

      • typeIdentifier — required — (String)

        The type ID of the time series data points summary form.

      • typeRevision — (String)

        The type revision of the time series data points summary form.

    • listing — (map)

      The details of an asset published in an Amazon DataZone catalog.

      • listingId — required — (String)

        The identifier of an asset published in an Amazon DataZone catalog.

      • listingStatus — required — (String)

        The status of an asset published in an Amazon DataZone catalog.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "INACTIVE"
    • name — (String)

      The name of the created asset.

    • owningProjectId — (String)

      The ID of the Amazon DataZone project that owns the created asset.

    • predictionConfiguration — (map)

      The configuration of the automatically generated business-friendly metadata for the asset.

      • businessNameGeneration — (map)

        The business name generation mechanism.

        • enabled — (Boolean)

          Specifies whether the business name generation is enabled.

    • readOnlyFormsOutput — (Array<map>)

      The read-only metadata forms that are attached to the created asset.

      • content — (String)

        The content of the metadata form.

      • formName — required — (String)

        The name of the metadata form.

      • typeName — (String)

        The name of the metadata form type.

      • typeRevision — (String)

        The revision of the metadata form type.

    • revision — (String)

      The revision of the asset.

    • typeIdentifier — (String)

      The identifier of the created asset type.

    • typeRevision — (String)

      The revision type of the asset.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  formsInput: [
    {
      formName: 'STRING_VALUE', /* required */
      content: 'STRING_VALUE',
      typeIdentifier: 'STRING_VALUE',
      typeRevision: 'STRING_VALUE'
    },
    /* more items */
  ],
  glossaryTerms: [
    'STRING_VALUE',
    /* more items */
  ],
  predictionConfiguration: {
    businessNameGeneration: {
      enabled: true || false
    }
  },
  typeRevision: 'STRING_VALUE'
};
datazone.createAssetRevision(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    The revised description of the asset.

  • domainIdentifier — (String)

    The unique identifier of the domain where the asset is being revised.

  • formsInput — (Array<map>)

    The metadata forms to be attached to the asset as part of asset revision.

    • content — (String)

      The content of the metadata form.

    • formName — required — (String)

      The name of the metadata form.

    • typeIdentifier — (String)

      The ID of the metadata form type.

    • typeRevision — (String)

      The revision of the metadata form type.

  • glossaryTerms — (Array<String>)

    The glossary terms to be attached to the asset as part of asset revision.

  • identifier — (String)

    The identifier of the asset.

  • name — (String)

    Te revised name of the asset.

  • predictionConfiguration — (map)

    The configuration of the automatically generated business-friendly metadata for the asset.

    • businessNameGeneration — (map)

      The business name generation mechanism.

      • enabled — (Boolean)

        Specifies whether the business name generation is enabled.

  • typeRevision — (String)

    The revision type of the asset.

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:

    • createdAt — (Date)

      The timestamp of when the asset revision occured.

    • createdBy — (String)

      The Amazon DataZone user who performed the asset revision.

    • description — (String)

      The revised asset description.

    • domainId — (String)

      The unique identifier of the Amazon DataZone domain where the asset was revised.

    • externalIdentifier — (String)

      The external identifier of the asset.

    • firstRevisionCreatedAt — (Date)

      The timestamp of when the first asset revision occured.

    • firstRevisionCreatedBy — (String)

      The Amazon DataZone user who performed the first asset revision.

    • formsOutput — (Array<map>)

      The metadata forms that were attached to the asset as part of the asset revision.

      • content — (String)

        The content of the metadata form.

      • formName — required — (String)

        The name of the metadata form.

      • typeName — (String)

        The name of the metadata form type.

      • typeRevision — (String)

        The revision of the metadata form type.

    • glossaryTerms — (Array<String>)

      The glossary terms that were attached to the asset as part of asset revision.

    • id — (String)

      The unique identifier of the asset revision.

    • latestTimeSeriesDataPointFormsOutput — (Array<map>)

      The latest data point that was imported into the time series form for the asset.

      • contentSummary — (String)

        The content of the summary of the time series data points form.

      • formName — required — (String)

        The name of the time series data points summary form.

      • id — (String)

        The ID of the time series data points summary form.

      • timestamp — required — (Date)

        The timestamp of the time series data points summary form.

      • typeIdentifier — required — (String)

        The type ID of the time series data points summary form.

      • typeRevision — (String)

        The type revision of the time series data points summary form.

    • listing — (map)

      The details of an asset published in an Amazon DataZone catalog.

      • listingId — required — (String)

        The identifier of an asset published in an Amazon DataZone catalog.

      • listingStatus — required — (String)

        The status of an asset published in an Amazon DataZone catalog.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "INACTIVE"
    • name — (String)

      The revised name of the asset.

    • owningProjectId — (String)

      The unique identifier of the revised project that owns the asset.

    • predictionConfiguration — (map)

      The configuration of the automatically generated business-friendly metadata for the asset.

      • businessNameGeneration — (map)

        The business name generation mechanism.

        • enabled — (Boolean)

          Specifies whether the business name generation is enabled.

    • readOnlyFormsOutput — (Array<map>)

      The read-only metadata forms that were attached to the asset as part of the asset revision.

      • content — (String)

        The content of the metadata form.

      • formName — required — (String)

        The name of the metadata form.

      • typeName — (String)

        The name of the metadata form type.

      • typeRevision — (String)

        The revision of the metadata form type.

    • revision — (String)

      The revision of the asset.

    • typeIdentifier — (String)

      The identifier of the revision type.

    • typeRevision — (String)

      The revision type of the asset.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  formsInput: { /* required */
    '<FormName>': {
      typeIdentifier: 'STRING_VALUE', /* required */
      typeRevision: 'STRING_VALUE', /* required */
      required: true || false
    },
    /* '<FormName>': ... */
  },
  name: 'STRING_VALUE', /* required */
  owningProjectIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE'
};
datazone.createAssetType(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: {}) —
  • description — (String)

    The descripton of the custom asset type.

  • domainIdentifier — (String)

    The unique identifier of the Amazon DataZone domain where the custom asset type is being created.

  • formsInput — (map<map>)

    The metadata forms that are to be attached to the custom asset type.

    • required — (Boolean)

      Specifies whether a form entry is required.

    • typeIdentifier — required — (String)

      The type ID of the form entry.

    • typeRevision — required — (String)

      The type revision of the form entry.

  • name — (String)

    The name of the custom asset type.

  • owningProjectIdentifier — (String)

    The identifier of the Amazon DataZone project that is to own the custom asset type.

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:

    • createdAt — (Date)

      The timestamp of when the asset type is to be created.

    • createdBy — (String)

      The Amazon DataZone user who creates this custom asset type.

    • description — (String)

      The description of the custom asset type.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which the asset type was created.

    • formsOutput — (map<map>)

      The metadata forms that are attached to the asset type.

      • required — (Boolean)

        Specifies whether a form entry is required.

      • typeName — required — (String)

        The name of the type of the form entry.

      • typeRevision — required — (String)

        The type revision of the form entry.

    • name — (String)

      The name of the asset type.

    • originDomainId — (String)

      The ID of the Amazon DataZone domain where the asset type was originally created.

    • originProjectId — (String)

      The ID of the Amazon DataZone project where the asset type was originally created.

    • owningProjectId — (String)

      The ID of the Amazon DataZone project that currently owns this asset type.

    • revision — (String)

      The revision of the custom asset type.

    • updatedAt — (Date)

      The timestamp of when the custom type was created.

    • updatedBy — (String)

      The Amazon DataZone user that created the custom asset type.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  projectIdentifier: 'STRING_VALUE', /* required */
  type: 'STRING_VALUE', /* required */
  assetFormsInput: [
    {
      formName: 'STRING_VALUE', /* required */
      content: 'STRING_VALUE',
      typeIdentifier: 'STRING_VALUE',
      typeRevision: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  configuration: {
    glueRunConfiguration: {
      relationalFilterConfigurations: [ /* required */
        {
          databaseName: 'STRING_VALUE', /* required */
          filterExpressions: [
            {
              expression: 'STRING_VALUE', /* required */
              type: INCLUDE | EXCLUDE /* required */
            },
            /* more items */
          ],
          schemaName: 'STRING_VALUE'
        },
        /* more items */
      ],
      autoImportDataQualityResult: true || false,
      dataAccessRole: 'STRING_VALUE'
    },
    redshiftRunConfiguration: {
      redshiftCredentialConfiguration: { /* required */
        secretManagerArn: 'STRING_VALUE' /* required */
      },
      redshiftStorage: { /* required */
        redshiftClusterSource: {
          clusterName: 'STRING_VALUE' /* required */
        },
        redshiftServerlessSource: {
          workgroupName: 'STRING_VALUE' /* required */
        }
      },
      relationalFilterConfigurations: [ /* required */
        {
          databaseName: 'STRING_VALUE', /* required */
          filterExpressions: [
            {
              expression: 'STRING_VALUE', /* required */
              type: INCLUDE | EXCLUDE /* required */
            },
            /* more items */
          ],
          schemaName: 'STRING_VALUE'
        },
        /* more items */
      ],
      dataAccessRole: 'STRING_VALUE'
    }
  },
  description: 'STRING_VALUE',
  enableSetting: ENABLED | DISABLED,
  publishOnImport: true || false,
  recommendation: {
    enableBusinessNameGeneration: true || false
  },
  schedule: {
    schedule: 'STRING_VALUE',
    timezone: UTC | AFRICA_JOHANNESBURG | AMERICA_MONTREAL | AMERICA_SAO_PAULO | ASIA_BAHRAIN | ASIA_BANGKOK | ASIA_CALCUTTA | ASIA_DUBAI | ASIA_HONG_KONG | ASIA_JAKARTA | ASIA_KUALA_LUMPUR | ASIA_SEOUL | ASIA_SHANGHAI | ASIA_SINGAPORE | ASIA_TAIPEI | ASIA_TOKYO | AUSTRALIA_MELBOURNE | AUSTRALIA_SYDNEY | CANADA_CENTRAL | CET | CST6CDT | ETC_GMT | ETC_GMT0 | ETC_GMT_ADD_0 | ETC_GMT_ADD_1 | ETC_GMT_ADD_10 | ETC_GMT_ADD_11 | ETC_GMT_ADD_12 | ETC_GMT_ADD_2 | ETC_GMT_ADD_3 | ETC_GMT_ADD_4 | ETC_GMT_ADD_5 | ETC_GMT_ADD_6 | ETC_GMT_ADD_7 | ETC_GMT_ADD_8 | ETC_GMT_ADD_9 | ETC_GMT_NEG_0 | ETC_GMT_NEG_1 | ETC_GMT_NEG_10 | ETC_GMT_NEG_11 | ETC_GMT_NEG_12 | ETC_GMT_NEG_13 | ETC_GMT_NEG_14 | ETC_GMT_NEG_2 | ETC_GMT_NEG_3 | ETC_GMT_NEG_4 | ETC_GMT_NEG_5 | ETC_GMT_NEG_6 | ETC_GMT_NEG_7 | ETC_GMT_NEG_8 | ETC_GMT_NEG_9 | EUROPE_DUBLIN | EUROPE_LONDON | EUROPE_PARIS | EUROPE_STOCKHOLM | EUROPE_ZURICH | ISRAEL | MEXICO_GENERAL | MST7MDT | PACIFIC_AUCKLAND | US_CENTRAL | US_EASTERN | US_MOUNTAIN | US_PACIFIC
  }
};
datazone.createDataSource(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: {}) —
  • assetFormsInput — (Array<map>)

    The metadata forms that are to be attached to the assets that this data source works with.

    • content — (String)

      The content of the metadata form.

    • formName — required — (String)

      The name of the metadata form.

    • typeIdentifier — (String)

      The ID of the metadata form type.

    • typeRevision — (String)

      The revision of the metadata form type.

  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • configuration — (map)

    Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

    • glueRunConfiguration — (map)

      The configuration of the Amazon Web Services Glue data source.

      • autoImportDataQualityResult — (Boolean)

        Specifies whether to automatically import data quality metrics as part of the data source run.

      • dataAccessRole — (String)

        The data access role included in the configuration details of the Amazon Web Services Glue data source.

      • relationalFilterConfigurations — required — (Array<map>)

        The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

        • databaseName — required — (String)

          The database name specified in the relational filter configuration for the data source.

        • filterExpressions — (Array<map>)

          The filter expressions specified in the relational filter configuration for the data source.

          • expression — required — (String)

            The search filter expression.

          • type — required — (String)

            The search filter explresison type.

            Possible values include:
            • "INCLUDE"
            • "EXCLUDE"
        • schemaName — (String)

          The schema name specified in the relational filter configuration for the data source.

    • redshiftRunConfiguration — (map)

      The configuration of the Amazon Redshift data source.

      • dataAccessRole — (String)

        The data access role included in the configuration details of the Amazon Redshift data source.

      • redshiftCredentialConfiguration — required — (map)

        The details of the credentials required to access an Amazon Redshift cluster.

        • secretManagerArn — required — (String)

          The ARN of a secret manager for an Amazon Redshift cluster.

      • redshiftStorage — required — (map)

        The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

        • redshiftClusterSource — (map)

          The details of the Amazon Redshift cluster source.

          • clusterName — required — (String)

            The name of an Amazon Redshift cluster.

        • redshiftServerlessSource — (map)

          The details of the Amazon Redshift Serverless workgroup source.

          • workgroupName — required — (String)

            The name of the Amazon Redshift Serverless workgroup.

      • relationalFilterConfigurations — required — (Array<map>)

        The relational filger configurations included in the configuration details of the Amazon Redshift data source.

        • databaseName — required — (String)

          The database name specified in the relational filter configuration for the data source.

        • filterExpressions — (Array<map>)

          The filter expressions specified in the relational filter configuration for the data source.

          • expression — required — (String)

            The search filter expression.

          • type — required — (String)

            The search filter explresison type.

            Possible values include:
            • "INCLUDE"
            • "EXCLUDE"
        • schemaName — (String)

          The schema name specified in the relational filter configuration for the data source.

  • description — (String)

    The description of the data source.

  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain where the data source is created.

  • enableSetting — (String)

    Specifies whether the data source is enabled.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • environmentIdentifier — (String)

    The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

  • name — (String)

    The name of the data source.

  • projectIdentifier — (String)

    The identifier of the Amazon DataZone project in which you want to add this data source.

  • publishOnImport — (Boolean)

    Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

  • recommendation — (map)

    Specifies whether the business name generation is to be enabled for this data source.

    • enableBusinessNameGeneration — (Boolean)

      Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

  • schedule — (map)

    The schedule of the data source runs.

    • schedule — (String)

      The schedule of the data source runs.

    • timezone — (String)

      The timezone of the data source run.

      Possible values include:
      • "UTC"
      • "AFRICA_JOHANNESBURG"
      • "AMERICA_MONTREAL"
      • "AMERICA_SAO_PAULO"
      • "ASIA_BAHRAIN"
      • "ASIA_BANGKOK"
      • "ASIA_CALCUTTA"
      • "ASIA_DUBAI"
      • "ASIA_HONG_KONG"
      • "ASIA_JAKARTA"
      • "ASIA_KUALA_LUMPUR"
      • "ASIA_SEOUL"
      • "ASIA_SHANGHAI"
      • "ASIA_SINGAPORE"
      • "ASIA_TAIPEI"
      • "ASIA_TOKYO"
      • "AUSTRALIA_MELBOURNE"
      • "AUSTRALIA_SYDNEY"
      • "CANADA_CENTRAL"
      • "CET"
      • "CST6CDT"
      • "ETC_GMT"
      • "ETC_GMT0"
      • "ETC_GMT_ADD_0"
      • "ETC_GMT_ADD_1"
      • "ETC_GMT_ADD_10"
      • "ETC_GMT_ADD_11"
      • "ETC_GMT_ADD_12"
      • "ETC_GMT_ADD_2"
      • "ETC_GMT_ADD_3"
      • "ETC_GMT_ADD_4"
      • "ETC_GMT_ADD_5"
      • "ETC_GMT_ADD_6"
      • "ETC_GMT_ADD_7"
      • "ETC_GMT_ADD_8"
      • "ETC_GMT_ADD_9"
      • "ETC_GMT_NEG_0"
      • "ETC_GMT_NEG_1"
      • "ETC_GMT_NEG_10"
      • "ETC_GMT_NEG_11"
      • "ETC_GMT_NEG_12"
      • "ETC_GMT_NEG_13"
      • "ETC_GMT_NEG_14"
      • "ETC_GMT_NEG_2"
      • "ETC_GMT_NEG_3"
      • "ETC_GMT_NEG_4"
      • "ETC_GMT_NEG_5"
      • "ETC_GMT_NEG_6"
      • "ETC_GMT_NEG_7"
      • "ETC_GMT_NEG_8"
      • "ETC_GMT_NEG_9"
      • "EUROPE_DUBLIN"
      • "EUROPE_LONDON"
      • "EUROPE_PARIS"
      • "EUROPE_STOCKHOLM"
      • "EUROPE_ZURICH"
      • "ISRAEL"
      • "MEXICO_GENERAL"
      • "MST7MDT"
      • "PACIFIC_AUCKLAND"
      • "US_CENTRAL"
      • "US_EASTERN"
      • "US_MOUNTAIN"
      • "US_PACIFIC"
  • type — (String)

    The type of the data source.

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:

    • assetFormsOutput — (Array<map>)

      The metadata forms attached to the assets that this data source creates.

      • content — (String)

        The content of the metadata form.

      • formName — required — (String)

        The name of the metadata form.

      • typeName — (String)

        The name of the metadata form type.

      • typeRevision — (String)

        The revision of the metadata form type.

    • configuration — (map)

      Specifies the configuration of the data source. It can be set to either glueRunConfiguration or redshiftRunConfiguration.

      • glueRunConfiguration — (map)

        The configuration of the Amazon Web Services Glue data source.

        • accountId — (String)

          The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source.

        • autoImportDataQualityResult — (Boolean)

          Specifies whether to automatically import data quality metrics as part of the data source run.

        • dataAccessRole — (String)

          The data access role included in the configuration details of the Amazon Web Services Glue data source.

        • region — (String)

          The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.

        • relationalFilterConfigurations — required — (Array<map>)

          The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

          • databaseName — required — (String)

            The database name specified in the relational filter configuration for the data source.

          • filterExpressions — (Array<map>)

            The filter expressions specified in the relational filter configuration for the data source.

            • expression — required — (String)

              The search filter expression.

            • type — required — (String)

              The search filter explresison type.

              Possible values include:
              • "INCLUDE"
              • "EXCLUDE"
          • schemaName — (String)

            The schema name specified in the relational filter configuration for the data source.

      • redshiftRunConfiguration — (map)

        The configuration of the Amazon Redshift data source.

        • accountId — (String)

          The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source.

        • dataAccessRole — (String)

          The data access role included in the configuration details of the Amazon Redshift data source.

        • redshiftCredentialConfiguration — required — (map)

          The details of the credentials required to access an Amazon Redshift cluster.

          • secretManagerArn — required — (String)

            The ARN of a secret manager for an Amazon Redshift cluster.

        • redshiftStorage — required — (map)

          The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

          • redshiftClusterSource — (map)

            The details of the Amazon Redshift cluster source.

            • clusterName — required — (String)

              The name of an Amazon Redshift cluster.

          • redshiftServerlessSource — (map)

            The details of the Amazon Redshift Serverless workgroup source.

            • workgroupName — required — (String)

              The name of the Amazon Redshift Serverless workgroup.

        • region — (String)

          The Amazon Web Services region included in the configuration details of the Amazon Redshift data source.

        • relationalFilterConfigurations — required — (Array<map>)

          The relational filger configurations included in the configuration details of the Amazon Redshift data source.

          • databaseName — required — (String)

            The database name specified in the relational filter configuration for the data source.

          • filterExpressions — (Array<map>)

            The filter expressions specified in the relational filter configuration for the data source.

            • expression — required — (String)

              The search filter expression.

            • type — required — (String)

              The search filter explresison type.

              Possible values include:
              • "INCLUDE"
              • "EXCLUDE"
          • schemaName — (String)

            The schema name specified in the relational filter configuration for the data source.

    • createdAt — (Date)

      The timestamp of when the data source was created.

    • description — (String)

      The description of the data source.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which the data source is created.

    • enableSetting — (String)

      Specifies whether the data source is enabled.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • environmentId — (String)

      The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

    • errorMessage — (map)

      Specifies the error message that is returned if the operation cannot be successfully completed.

      • errorDetail — (String)

        The details of the error message that is returned if the operation cannot be successfully completed.

      • errorType — required — (String)

        The type of the error message that is returned if the operation cannot be successfully completed.

        Possible values include:
        • "ACCESS_DENIED_EXCEPTION"
        • "CONFLICT_EXCEPTION"
        • "INTERNAL_SERVER_EXCEPTION"
        • "RESOURCE_NOT_FOUND_EXCEPTION"
        • "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
        • "THROTTLING_EXCEPTION"
        • "VALIDATION_EXCEPTION"
    • id — (String)

      The unique identifier of the data source.

    • lastRunAt — (Date)

      The timestamp that specifies when the data source was last run.

    • lastRunErrorMessage — (map)

      Specifies the error message that is returned if the operation cannot be successfully completed.

      • errorDetail — (String)

        The details of the error message that is returned if the operation cannot be successfully completed.

      • errorType — required — (String)

        The type of the error message that is returned if the operation cannot be successfully completed.

        Possible values include:
        • "ACCESS_DENIED_EXCEPTION"
        • "CONFLICT_EXCEPTION"
        • "INTERNAL_SERVER_EXCEPTION"
        • "RESOURCE_NOT_FOUND_EXCEPTION"
        • "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
        • "THROTTLING_EXCEPTION"
        • "VALIDATION_EXCEPTION"
    • lastRunStatus — (String)

      The status of the last run of this data source.

      Possible values include:
      • "REQUESTED"
      • "RUNNING"
      • "FAILED"
      • "PARTIALLY_SUCCEEDED"
      • "SUCCESS"
    • name — (String)

      The name of the data source.

    • projectId — (String)

      The ID of the Amazon DataZone project to which the data source is added.

    • publishOnImport — (Boolean)

      Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

    • recommendation — (map)

      Specifies whether the business name generation is to be enabled for this data source.

      • enableBusinessNameGeneration — (Boolean)

        Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.

    • schedule — (map)

      The schedule of the data source runs.

      • schedule — (String)

        The schedule of the data source runs.

      • timezone — (String)

        The timezone of the data source run.

        Possible values include:
        • "UTC"
        • "AFRICA_JOHANNESBURG"
        • "AMERICA_MONTREAL"
        • "AMERICA_SAO_PAULO"
        • "ASIA_BAHRAIN"
        • "ASIA_BANGKOK"
        • "ASIA_CALCUTTA"
        • "ASIA_DUBAI"
        • "ASIA_HONG_KONG"
        • "ASIA_JAKARTA"
        • "ASIA_KUALA_LUMPUR"
        • "ASIA_SEOUL"
        • "ASIA_SHANGHAI"
        • "ASIA_SINGAPORE"
        • "ASIA_TAIPEI"
        • "ASIA_TOKYO"
        • "AUSTRALIA_MELBOURNE"
        • "AUSTRALIA_SYDNEY"
        • "CANADA_CENTRAL"
        • "CET"
        • "CST6CDT"
        • "ETC_GMT"
        • "ETC_GMT0"
        • "ETC_GMT_ADD_0"
        • "ETC_GMT_ADD_1"
        • "ETC_GMT_ADD_10"
        • "ETC_GMT_ADD_11"
        • "ETC_GMT_ADD_12"
        • "ETC_GMT_ADD_2"
        • "ETC_GMT_ADD_3"
        • "ETC_GMT_ADD_4"
        • "ETC_GMT_ADD_5"
        • "ETC_GMT_ADD_6"
        • "ETC_GMT_ADD_7"
        • "ETC_GMT_ADD_8"
        • "ETC_GMT_ADD_9"
        • "ETC_GMT_NEG_0"
        • "ETC_GMT_NEG_1"
        • "ETC_GMT_NEG_10"
        • "ETC_GMT_NEG_11"
        • "ETC_GMT_NEG_12"
        • "ETC_GMT_NEG_13"
        • "ETC_GMT_NEG_14"
        • "ETC_GMT_NEG_2"
        • "ETC_GMT_NEG_3"
        • "ETC_GMT_NEG_4"
        • "ETC_GMT_NEG_5"
        • "ETC_GMT_NEG_6"
        • "ETC_GMT_NEG_7"
        • "ETC_GMT_NEG_8"
        • "ETC_GMT_NEG_9"
        • "EUROPE_DUBLIN"
        • "EUROPE_LONDON"
        • "EUROPE_PARIS"
        • "EUROPE_STOCKHOLM"
        • "EUROPE_ZURICH"
        • "ISRAEL"
        • "MEXICO_GENERAL"
        • "MST7MDT"
        • "PACIFIC_AUCKLAND"
        • "US_CENTRAL"
        • "US_EASTERN"
        • "US_MOUNTAIN"
        • "US_PACIFIC"
    • status — (String)

      The status of the data source.

      Possible values include:
      • "CREATING"
      • "FAILED_CREATION"
      • "READY"
      • "UPDATING"
      • "FAILED_UPDATE"
      • "RUNNING"
      • "DELETING"
      • "FAILED_DELETION"
    • type — (String)

      The type of the data source.

    • updatedAt — (Date)

      The timestamp of when the data source was updated.

Returns:

• (AWS.Request) —

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

var params = {
  domainExecutionRole: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  kmsKeyIdentifier: 'STRING_VALUE',
  singleSignOn: {
    type: IAM_IDC | DISABLED,
    userAssignment: AUTOMATIC | MANUAL
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
datazone.createDomain(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    The description of the Amazon DataZone domain.

  • domainExecutionRole — (String)

    The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

  • kmsKeyIdentifier — (String)

    The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

  • name — (String)

    The name of the Amazon DataZone domain.

  • singleSignOn — (map)

    The single-sign on configuration of the Amazon DataZone domain.

    • type — (String)

      The type of single sign-on in Amazon DataZone.

      Possible values include:
      • "IAM_IDC"
      • "DISABLED"
    • userAssignment — (String)

      The single sign-on user assignment in Amazon DataZone.

      Possible values include:
      • "AUTOMATIC"
      • "MANUAL"
  • tags — (map<String>)

    The tags specified for the Amazon DataZone domain.

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 of the Amazon DataZone domain.

    • description — (String)

      The description of the Amazon DataZone domain.

    • domainExecutionRole — (String)

      The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

    • id — (String)

      The identifier of the Amazon DataZone domain.

    • kmsKeyIdentifier — (String)

      The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

    • name — (String)

      The name of the Amazon DataZone domain.

    • portalUrl — (String)

      The URL of the data portal for this Amazon DataZone domain.

    • singleSignOn — (map)

      The single-sign on configuration of the Amazon DataZone domain.

      • type — (String)

        The type of single sign-on in Amazon DataZone.

        Possible values include:
        • "IAM_IDC"
        • "DISABLED"
      • userAssignment — (String)

        The single sign-on user assignment in Amazon DataZone.

        Possible values include:
        • "AUTOMATIC"
        • "MANUAL"
    • status — (String)

      The status of the Amazon DataZone domain.

      Possible values include:
      • "CREATING"
      • "AVAILABLE"
      • "CREATION_FAILED"
      • "DELETING"
      • "DELETED"
      • "DELETION_FAILED"
    • tags — (map<String>)

      The tags specified for the Amazon DataZone domain.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentProfileIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  projectIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  glossaryTerms: [
    'STRING_VALUE',
    /* more items */
  ],
  userParameters: [
    {
      name: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datazone.createEnvironment(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: {}) —
  • description — (String)

    The description of the Amazon DataZone environment.

  • domainIdentifier — (String)

    The identifier of the Amazon DataZone domain in which the environment is created.

  • environmentProfileIdentifier — (String)

    The identifier of the environment profile that is used to create this Amazon DataZone environment.

  • glossaryTerms — (Array<String>)

    The glossary terms that can be used in this Amazon DataZone environment.

  • name — (String)

    The name of the Amazon DataZone environment.

  • projectIdentifier — (String)

    The identifier of the Amazon DataZone project in which this environment is created.

  • userParameters — (Array<map>)

    The user parameters of this Amazon DataZone environment.

    • name — (String)

      The name of an environment profile parameter.

    • value — (String)

      The value of an environment profile parameter.

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:

    • awsAccountId — (String)

      The Amazon Web Services account in which the Amazon DataZone environment is created.

    • awsAccountRegion — (String)

      The Amazon Web Services region in which the Amazon DataZone environment is created.

    • createdAt — (Date)

      The timestamp of when the environment was created.

    • createdBy — (String)

      The Amazon DataZone user who created this environment.

    • deploymentProperties — (map)

      The deployment properties of this Amazon DataZone environment.

      • endTimeoutMinutes — (Integer)

        The end timeout of the environment blueprint deployment.

      • startTimeoutMinutes — (Integer)

        The start timeout of the environment blueprint deployment.

    • description — (String)

      The description of this Amazon DataZone environment.

    • domainId — (String)

      The identifier of the Amazon DataZone domain in which the environment is created.

    • environmentActions — (Array<map>)

      The configurable actions of this Amazon DataZone environment.

      • auth — (String)

        The authentication type of a configurable action of a Amazon DataZone environment.

        Possible values include:
        • "IAM"
        • "HTTPS"
      • parameters — required — (Array<map>)

        The parameters of a configurable action in a Amazon DataZone environment.

        • key — (String)

          The key of the configurable action parameter.

        • value — (String)

          The value of the configurable action parameter.

      • type — required — (String)

        The type of a configurable action in a Amazon DataZone environment.

    • environmentBlueprintId — (String)

      The ID of the blueprint with which this Amazon DataZone environment was created.

    • environmentProfileId — (String)

      The ID of the environment profile with which this Amazon DataZone environment was created.

    • glossaryTerms — (Array<String>)

      The glossary terms that can be used in this Amazon DataZone environment.

    • id — (String)

      The ID of this Amazon DataZone environment.

    • lastDeployment — (map)

      The details of the last deployment of this Amazon DataZone environment.

      • deploymentId — (String)

        The identifier of the last deployment of the environment.

      • deploymentStatus — (String)

        The status of the last deployment of the environment.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCESSFUL"
        • "FAILED"
        • "PENDING_DEPLOYMENT"
      • deploymentType — (String)

        The type of the last deployment of the environment.

        Possible values include:
        • "CREATE"
        • "UPDATE"
        • "DELETE"
      • failureReason — (map)

        The failure reason of the last deployment of the environment.

        • code — (String)

          The error code for the failure reason for the environment deployment.

        • message — required — (String)

          The error message for the failure reason for the environment deployment.

      • isDeploymentComplete — (Boolean)

        Specifies whether the last deployment of the environment is complete.

      • messages — (Array<String>)

        The messages of the last deployment of the environment.

    • name — (String)

      The name of this environment.

    • projectId — (String)

      The ID of the Amazon DataZone project in which this environment is created.

    • provider — (String)

      The provider of this Amazon DataZone environment.

    • provisionedResources — (Array<map>)

      The provisioned resources of this Amazon DataZone environment.

      • name — (String)

        The name of a provisioned resource of this Amazon DataZone environment.

      • provider — (String)

        The provider of a provisioned resource of this Amazon DataZone environment.

      • type — required — (String)

        The type of a provisioned resource of this Amazon DataZone environment.

      • value — required — (String)

        The value of a provisioned resource of this Amazon DataZone environment.

    • provisioningProperties — (map)

      The provisioning properties of this Amazon DataZone environment.

      • cloudFormation — (map)

        The cloud formation properties included as part of the provisioning properties of an environment blueprint.

        • templateUrl — required — (String)

          The template URL of the cloud formation provisioning properties of the environment blueprint.

    • status — (String)

      The status of this Amazon DataZone environment.

      Possible values include:
      • "ACTIVE"
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "CREATE_FAILED"
      • "UPDATE_FAILED"
      • "DELETE_FAILED"
      • "VALIDATION_FAILED"
      • "SUSPENDED"
      • "DISABLED"
      • "EXPIRED"
      • "DELETED"
      • "INACCESSIBLE"
    • updatedAt — (Date)

      The timestamp of when this environment was updated.

    • userParameters — (Array<map>)

      The user parameters of this Amazon DataZone environment.

      • defaultValue — (String)

        The default value of the parameter.

      • description — (String)

        The description of the parameter.

      • fieldType — required — (String)

        The filed type of the parameter.

      • isEditable — (Boolean)

        Specifies whether the parameter is editable.

      • isOptional — (Boolean)

        Specifies whether the custom parameter is optional.

      • keyName — required — (String)

        The key name of the parameter.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentBlueprintIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  projectIdentifier: 'STRING_VALUE', /* required */
  awsAccountId: 'STRING_VALUE',
  awsAccountRegion: 'STRING_VALUE',
  description: 'STRING_VALUE',
  userParameters: [
    {
      name: 'STRING_VALUE',
      value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datazone.createEnvironmentProfile(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: {}) —
  • awsAccountId — (String)

    The Amazon Web Services account in which the Amazon DataZone environment is created.

  • awsAccountRegion — (String)

    The Amazon Web Services region in which this environment profile is created.

  • description — (String)

    The description of this Amazon DataZone environment profile.

  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which this environment profile is created.

  • environmentBlueprintIdentifier — (String)

    The ID of the blueprint with which this environment profile is created.

  • name — (String)

    The name of this Amazon DataZone environment profile.

  • projectIdentifier — (String)

    The identifier of the project in which to create the environment profile.

  • userParameters — (Array<map>)

    The user parameters of this Amazon DataZone environment profile.

    • name — (String)

      The name of an environment profile parameter.

    • value — (String)

      The value of an environment profile parameter.

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:

    • awsAccountId — (String)

      The Amazon Web Services account ID in which this Amazon DataZone environment profile is created.

    • awsAccountRegion — (String)

      The Amazon Web Services region in which this Amazon DataZone environment profile is created.

    • createdAt — (Date)

      The timestamp of when this environment profile was created.

    • createdBy — (String)

      The Amazon DataZone user who created this environment profile.

    • description — (String)

      The description of this Amazon DataZone environment profile.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which this environment profile is created.

    • environmentBlueprintId — (String)

      The ID of the blueprint with which this environment profile is created.

    • id — (String)

      The ID of this Amazon DataZone environment profile.

    • name — (String)

      The name of this Amazon DataZone environment profile.

    • projectId — (String)

      The ID of the Amazon DataZone project in which this environment profile is created.

    • updatedAt — (Date)

      The timestamp of when this environment profile was updated.

    • userParameters — (Array<map>)

      The user parameters of this Amazon DataZone environment profile.

      • defaultValue — (String)

        The default value of the parameter.

      • description — (String)

        The description of the parameter.

      • fieldType — required — (String)

        The filed type of the parameter.

      • isEditable — (Boolean)

        Specifies whether the parameter is editable.

      • isOptional — (Boolean)

        Specifies whether the custom parameter is optional.

      • keyName — required — (String)

        The key name of the parameter.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  model: { /* required */
    smithy: 'STRING_VALUE'
  },
  name: 'STRING_VALUE', /* required */
  owningProjectIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  status: ENABLED | DISABLED
};
datazone.createFormType(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: {}) —
  • description — (String)

    The description of this Amazon DataZone metadata form type.

  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which this metadata form type is created.

  • model — (map)

    The model of this Amazon DataZone metadata form type.

    • smithy — (String)

      Indicates the smithy model of the API.

  • name — (String)

    The name of this Amazon DataZone metadata form type.

  • owningProjectIdentifier — (String)

    The ID of the Amazon DataZone project that owns this metadata form type.

  • status — (String)

    The status of this Amazon DataZone metadata form type.

    Possible values include:
    • "ENABLED"
    • "DISABLED"

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:

    • description — (String)

      The description of this Amazon DataZone metadata form type.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which this metadata form type is created.

    • name — (String)

      The name of this Amazon DataZone metadata form type.

    • originDomainId — (String)

      The ID of the Amazon DataZone domain in which this metadata form type was originally created.

    • originProjectId — (String)

      The ID of the project in which this Amazon DataZone metadata form type was originally created.

    • owningProjectId — (String)

      The ID of the project that owns this Amazon DataZone metadata form type.

    • revision — (String)

      The revision of this Amazon DataZone metadata form type.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  owningProjectIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  status: DISABLED | ENABLED
};
datazone.createGlossary(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    The description of this business glossary.

  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which this business glossary is created.

  • name — (String)

    The name of this business glossary.

  • owningProjectIdentifier — (String)

    The ID of the project that currently owns business glossary.

  • status — (String)

    The status of this business glossary.

    Possible values include:
    • "DISABLED"
    • "ENABLED"

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:

    • description — (String)

      The description of this business glossary.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which this business glossary is created.

    • id — (String)

      The ID of this business glossary.

    • name — (String)

      The name of this business glossary.

    • owningProjectId — (String)

      The ID of the project that currently owns this business glossary.

    • status — (String)

      The status of this business glossary.

      Possible values include:
      • "DISABLED"
      • "ENABLED"

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  glossaryIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  longDescription: 'STRING_VALUE',
  shortDescription: 'STRING_VALUE',
  status: ENABLED | DISABLED,
  termRelations: {
    classifies: [
      'STRING_VALUE',
      /* more items */
    ],
    isA: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
datazone.createGlossaryTerm(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which this business glossary term is created.

  • glossaryIdentifier — (String)

    The ID of the business glossary in which this term is created.

  • longDescription — (String)

    The long description of this business glossary term.

  • name — (String)

    The name of this business glossary term.

  • shortDescription — (String)

    The short description of this business glossary term.

  • status — (String)

    The status of this business glossary term.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • termRelations — (map)

    The term relations of this business glossary term.

    • classifies — (Array<String>)

      The classifies of the term relations.

    • isA — (Array<String>)

      The isA property of the term relations.

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:

    • domainId — (String)

      The ID of the Amazon DataZone domain in which this business glossary term is created.

    • glossaryId — (String)

      The ID of the business glossary in which this term is created.

    • id — (String)

      The ID of this business glossary term.

    • longDescription — (String)

      The long description of this business glossary term.

    • name — (String)

      The name of this business glossary term.

    • shortDescription — (String)

      The short description of this business glossary term.

    • status — (String)

      The status of this business glossary term.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • termRelations — (map)

      The term relations of this business glossary term.

      • classifies — (Array<String>)

        The classifies of the term relations.

      • isA — (Array<String>)

        The isA property of the term relations.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  groupIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
datazone.createGroupProfile(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The identifier of the Amazon DataZone domain in which the group profile is created.

  • groupIdentifier — (String)

    The identifier of the group for which the group profile is created.

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:

    • domainId — (String)

      The identifier of the Amazon DataZone domain in which the group profile is created.

    • groupName — (String)

      The name of the group for which group profile is created.

    • id — (String)

      The identifier of the group profile.

    • status — (String)

      The status of the group profile.

      Possible values include:
      • "ASSIGNED"
      • "NOT_ASSIGNED"

Returns:

• (AWS.Request) —

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

var params = {
  action: PUBLISH | UNPUBLISH, /* required */
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: ASSET, /* required */
  clientToken: 'STRING_VALUE',
  entityRevision: 'STRING_VALUE'
};
datazone.createListingChangeSet(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: {}) —
  • action — (String)

    Specifies whether to publish or unpublish a listing.

    Possible values include:
    • "PUBLISH"
    • "UNPUBLISH"
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain.

  • entityIdentifier — (String)

    The ID of the asset.

  • entityRevision — (String)

    The revision of an asset.

  • entityType — (String)

    The type of an entity.

    Possible values include:
    • "ASSET"

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:

    • listingId — (String)

      The ID of the listing (a record of an asset at a given time).

    • listingRevision — (String)

      The revision of a listing.

    • status — (String)

      Specifies the status of the listing.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "INACTIVE"

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  glossaryTerms: [
    'STRING_VALUE',
    /* more items */
  ]
};
datazone.createProject(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: {}) —
  • description — (String)

    The description of the Amazon DataZone project.

  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which this project is created.

  • glossaryTerms — (Array<String>)

    The glossary terms that can be used in this Amazon DataZone project.

  • name — (String)

    The name of the Amazon DataZone project.

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:

    • createdAt — (Date)

      The timestamp of when the project was created.

    • createdBy — (String)

      The Amazon DataZone user who created the project.

    • description — (String)

      The description of the project.

    • domainId — (String)

      The identifier of the Amazon DataZone domain in which the project was created.

    • failureReasons — (Array<map>)

      Specifies the error message that is returned if the operation cannot be successfully completed.

      • code — (String)

        The code of the project deletion error.

      • message — (String)

        The message of the project deletion error.

    • glossaryTerms — (Array<String>)

      The glossary terms that can be used in the project.

    • id — (String)

      The ID of the Amazon DataZone project.

    • lastUpdatedAt — (Date)

      The timestamp of when the project was last updated.

    • name — (String)

      The name of the project.

    • projectStatus — (String)

      The status of the Amazon DataZone project that was created.

      Possible values include:
      • "ACTIVE"
      • "DELETING"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  designation: PROJECT_OWNER | PROJECT_CONTRIBUTOR, /* required */
  domainIdentifier: 'STRING_VALUE', /* required */
  member: { /* required */
    groupIdentifier: 'STRING_VALUE',
    userIdentifier: 'STRING_VALUE'
  },
  projectIdentifier: 'STRING_VALUE' /* required */
};
datazone.createProjectMembership(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: {}) —
  • designation — (String)

    The designation of the project membership.

    Possible values include:
    • "PROJECT_OWNER"
    • "PROJECT_CONTRIBUTOR"
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which project membership is created.

  • member — (map)

    The project member whose project membership was created.

    • groupIdentifier — (String)

      The ID of the group of a project member.

    • userIdentifier — (String)

      The user ID of a project member.

  • projectIdentifier — (String)

    The ID of the project for which this project membership was created.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  grantedEntity: { /* required */
    listing: {
      identifier: 'STRING_VALUE', /* required */
      revision: 'STRING_VALUE' /* required */
    }
  },
  subscriptionTargetIdentifier: 'STRING_VALUE', /* required */
  assetTargetNames: [
    {
      assetId: 'STRING_VALUE', /* required */
      targetName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
datazone.createSubscriptionGrant(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: {}) —
  • assetTargetNames — (Array<map>)

    The names of the assets for which the subscription grant is created.

    • assetId — required — (String)

      The identifier of the inventory asset.

    • targetName — required — (String)

      The target name in the asset target name map.

  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the subscription grant is created.

  • environmentIdentifier — (String)

    The ID of the environment in which the subscription grant is created.

  • grantedEntity — (map)

    The entity to which the subscription is to be granted.

    • listing — (map)

      The listing for which a subscription is to be granted.

      • identifier — required — (String)

        An identifier of revision to be made to an asset published in a Amazon DataZone catalog.

      • revision — required — (String)

        The details of a revision to be made to an asset published in a Amazon DataZone catalog.

  • subscriptionTargetIdentifier — (String)

    The ID of the subscription target for which the subscription grant is created.

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 assets for which the subscription grant is created.

      • assetId — required — (String)

        The identifier of the asset for which the subscription grant is created.

      • assetRevision — required — (String)

        The revision of the asset for which the subscription grant is created.

      • failureCause — (map)

        The failure cause included in the details of the asset for which the subscription grant is created.

        • message — (String)

          The description of the error message.

      • failureTimestamp — (Date)

        The failure timestamp included in the details of the asset for which the subscription grant is created.

      • grantedTimestamp — (Date)

        The timestamp of when the subscription grant to the asset is created.

      • status — required — (String)

        The status of the asset for which the subscription grant is created.

        Possible values include:
        • "GRANT_PENDING"
        • "REVOKE_PENDING"
        • "GRANT_IN_PROGRESS"
        • "REVOKE_IN_PROGRESS"
        • "GRANTED"
        • "REVOKED"
        • "GRANT_FAILED"
        • "REVOKE_FAILED"
      • targetName — (String)

        The target name of the asset for which the subscription grant is created.

    • createdAt — (Date)

      A timestamp of when the subscription grant is created.

    • createdBy — (String)

      The Amazon DataZone user who created the subscription grant.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which the subscription grant is created.

    • grantedEntity — (map)

      The entity to which the subscription is granted.

      • listing — (map)

        The listing for which a subscription is granted.

        • id — required — (String)

          An identifier of a revision of an asset published in a Amazon DataZone catalog.

        • revision — required — (String)

          The details of a revision of an asset published in a Amazon DataZone catalog.

    • id — (String)

      The ID of the subscription grant.

    • status — (String)

      The status of the subscription grant.

      Possible values include:
      • "PENDING"
      • "IN_PROGRESS"
      • "GRANT_FAILED"
      • "REVOKE_FAILED"
      • "GRANT_AND_REVOKE_FAILED"
      • "COMPLETED"
      • "INACCESSIBLE"
    • subscriptionId — (String)

      The identifier of the subscription grant.

    • subscriptionTargetId — (String)

      The ID of the subscription target for which the subscription grant is created.

    • updatedAt — (Date)

      A timestamp of when the subscription grant was updated.

    • updatedBy — (String)

      The Amazon DataZone user who updated the subscription grant.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  requestReason: 'STRING_VALUE', /* required */
  subscribedListings: [ /* required */
    {
      identifier: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  subscribedPrincipals: [ /* required */
    {
      project: {
        identifier: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
datazone.createSubscriptionRequest(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the subscription request is created.

  • requestReason — (String)

    The reason for the subscription request.

  • subscribedListings — (Array<map>)

    The published asset for which the subscription grant is to be created.

    • identifier — required — (String)

      The identifier of the published asset for which the subscription grant is to be created.

  • subscribedPrincipals — (Array<map>)

    The Amazon DataZone principals for whom the subscription request is created.

    • project — (map)

      The project that is to be given a subscription grant.

      • identifier — (String)

        The identifier of the project that is to be given a subscription grant.

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:

    • createdAt — (Date)

      A timestamp of when the subscription request is created.

    • createdBy — (String)

      The Amazon DataZone user who created the subscription request.

    • decisionComment — (String)

      The decision comment of the subscription request.

    • domainId — (String)

      The ID of the Amazon DataZone domain in whcih the subscription request is created.

    • id — (String)

      The ID of the subscription request.

    • requestReason — (String)

      The reason for the subscription request.

    • reviewerId — (String)

      The ID of the reviewer of the subscription request.

    • status — (String)

      The status of the subscription request.

      Possible values include:
      • "PENDING"
      • "ACCEPTED"
      • "REJECTED"
    • subscribedListings — (Array<map>)

      The published asset for which the subscription grant is to be created.

      • description — required — (String)

        The description of the published asset for which the subscription grant is created.

      • id — required — (String)

        The identifier of the published asset for which the subscription grant is created.

      • item — required — (map)

        The published asset for which the subscription grant is created.

        • assetListing — (map)

          The asset for which the subscription grant is created.

          • entityId — (String)

            The identifier of the published asset for which the subscription grant is created.

          • entityRevision — (String)

            The revision of the published asset for which the subscription grant is created.

          • entityType — (String)

            The type of the published asset for which the subscription grant is created.

          • forms — (String)

            The forms attached to the published asset for which the subscription grant is created.

          • glossaryTerms — (Array<map>)

            The glossary terms attached to the published asset for which the subscription grant is created.

            • name — (String)

              The name of a glossary term attached to the inventory asset.

            • shortDescription — (String)

              The shoft description of a glossary term attached to the inventory asset.

      • name — required — (String)

        The name of the published asset for which the subscription grant is created.

      • ownerProjectId — required — (String)

        The identifier of the project of the published asset for which the subscription grant is created.

      • ownerProjectName — (String)

        The name of the project that owns the published asset for which the subscription grant is created.

      • revision — (String)

        The revision of the published asset for which the subscription grant is created.

    • subscribedPrincipals — (Array<map>)

      The subscribed principals of the subscription request.

      • project — (map)

        The project that has the subscription grant.

        • id — (String)

          The identifier of the project that has the subscription grant.

        • name — (String)

          The name of the project that has the subscription grant.

    • updatedAt — (Date)

      The timestamp of when the subscription request was updated.

    • updatedBy — (String)

      The Amazon DataZone user who updated the subscription request.

Returns:

• (AWS.Request) —

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

var params = {
  applicableAssetTypes: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  authorizedPrincipals: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  manageAccessRole: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  subscriptionTargetConfig: [ /* required */
    {
      content: 'STRING_VALUE', /* required */
      formName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  type: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  provider: 'STRING_VALUE'
};
datazone.createSubscriptionTarget(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: {}) —
  • applicableAssetTypes — (Array<String>)

    The asset types that can be included in the subscription target.

  • authorizedPrincipals — (Array<String>)

    The authorized principals of the subscription target.

  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which subscription target is created.

  • environmentIdentifier — (String)

    The ID of the environment in which subscription target is created.

  • manageAccessRole — (String)

    The manage access role that is used to create the subscription target.

  • name — (String)

    The name of the subscription target.

  • provider — (String)

    The provider of the subscription target.

  • subscriptionTargetConfig — (Array<map>)

    The configuration of the subscription target.

    • content — required — (String)

      The content of the subscription target configuration.

    • formName — required — (String)

      The form name included in the subscription target configuration.

  • type — (String)

    The type of the subscription target.

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:

    • applicableAssetTypes — (Array<String>)

      The asset types that can be included in the subscription target.

    • authorizedPrincipals — (Array<String>)

      The authorised principals of the subscription target.

    • createdAt — (Date)

      The timestamp of when the subscription target was created.

    • createdBy — (String)

      The Amazon DataZone user who created the subscription target.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which the subscription target was created.

    • environmentId — (String)

      The ID of the environment in which the subscription target was created.

    • id — (String)

      The ID of the subscription target.

    • manageAccessRole — (String)

      The manage access role with which the subscription target was created.

    • name — (String)

      The name of the subscription target.

    • projectId — (String)

      ???

    • provider — (String)

      The provider of the subscription target.

    • subscriptionTargetConfig — (Array<map>)

      The configuration of the subscription target.

      • content — required — (String)

        The content of the subscription target configuration.

      • formName — required — (String)

        The form name included in the subscription target configuration.

    • type — (String)

      The type of the subscription target.

    • updatedAt — (Date)

      The timestamp of when the subscription target was updated.

    • updatedBy — (String)

      The Amazon DataZone user who updated the subscription target.

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  userIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  userType: IAM_USER | IAM_ROLE | SSO_USER
};
datazone.createUserProfile(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The identifier of the Amazon DataZone domain in which a user profile is created.

  • userIdentifier — (String)

    The identifier of the user for which the user profile is created.

  • userType — (String)

    The user type of the user for which the user profile is created.

    Possible values include:
    • "IAM_USER"
    • "IAM_ROLE"
    • "SSO_USER"

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:

    • details — (map)

      The details of the user profile in Amazon DataZone.

      • iam — (map)

        The IAM details included in the user profile details.

        • arn — (String)

          The ARN of an IAM user profile in Amazon DataZone.

      • sso — (map)

        The single sign-on details included in the user profile details.

        • firstName — (String)

          The first name included in the single sign-on details of the user profile.

        • lastName — (String)

          The last name included in the single sign-on details of the user profile.

        • username — (String)

          The username included in the single sign-on details of the user profile.

    • domainId — (String)

      The identifier of the Amazon DataZone domain in which a user profile is created.

    • id — (String)

      The identifier of the user profile.

    • status — (String)

      The status of the user profile.

      Possible values include:
      • "ASSIGNED"
      • "NOT_ASSIGNED"
      • "ACTIVATED"
      • "DEACTIVATED"
    • type — (String)

      The type of the user profile.

      Possible values include:
      • "IAM"
      • "SSO"

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the asset is deleted.

  • identifier — (String)

    The identifier of the asset that is deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteAssetType(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the asset type is deleted.

  • identifier — (String)

    The identifier of the asset type that is deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
datazone.deleteDataSource(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the data source is deleted.

  • identifier — (String)

    The identifier of the data source that is deleted.

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:

    • assetFormsOutput — (Array<map>)

      The asset data forms associated with this data source.

      • content — (String)

        The content of the metadata form.

      • formName — required — (String)

        The name of the metadata form.

      • typeName — (String)

        The name of the metadata form type.

      • typeRevision — (String)

        The revision of the metadata form type.

    • configuration — (map)

      The configuration of the data source that is deleted.

      • glueRunConfiguration — (map)

        The configuration of the Amazon Web Services Glue data source.

        • accountId — (String)

          The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data source.

        • autoImportDataQualityResult — (Boolean)

          Specifies whether to automatically import data quality metrics as part of the data source run.

        • dataAccessRole — (String)

          The data access role included in the configuration details of the Amazon Web Services Glue data source.

        • region — (String)

          The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source.

        • relationalFilterConfigurations — required — (Array<map>)

          The relational filter configurations included in the configuration details of the Amazon Web Services Glue data source.

          • databaseName — required — (String)

            The database name specified in the relational filter configuration for the data source.

          • filterExpressions — (Array<map>)

            The filter expressions specified in the relational filter configuration for the data source.

            • expression — required — (String)

              The search filter expression.

            • type — required — (String)

              The search filter explresison type.

              Possible values include:
              • "INCLUDE"
              • "EXCLUDE"
          • schemaName — (String)

            The schema name specified in the relational filter configuration for the data source.

      • redshiftRunConfiguration — (map)

        The configuration of the Amazon Redshift data source.

        • accountId — (String)

          The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift data source.

        • dataAccessRole — (String)

          The data access role included in the configuration details of the Amazon Redshift data source.

        • redshiftCredentialConfiguration — required — (map)

          The details of the credentials required to access an Amazon Redshift cluster.

          • secretManagerArn — required — (String)

            The ARN of a secret manager for an Amazon Redshift cluster.

        • redshiftStorage — required — (map)

          The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.

          • redshiftClusterSource — (map)

            The details of the Amazon Redshift cluster source.

            • clusterName — required — (String)

              The name of an Amazon Redshift cluster.

          • redshiftServerlessSource — (map)

            The details of the Amazon Redshift Serverless workgroup source.

            • workgroupName — required — (String)

              The name of the Amazon Redshift Serverless workgroup.

        • region — (String)

          The Amazon Web Services region included in the configuration details of the Amazon Redshift data source.

        • relationalFilterConfigurations — required — (Array<map>)

          The relational filger configurations included in the configuration details of the Amazon Redshift data source.

          • databaseName — required — (String)

            The database name specified in the relational filter configuration for the data source.

          • filterExpressions — (Array<map>)

            The filter expressions specified in the relational filter configuration for the data source.

            • expression — required — (String)

              The search filter expression.

            • type — required — (String)

              The search filter explresison type.

              Possible values include:
              • "INCLUDE"
              • "EXCLUDE"
          • schemaName — (String)

            The schema name specified in the relational filter configuration for the data source.

    • createdAt — (Date)

      The timestamp of when this data source was created.

    • description — (String)

      The description of the data source that is deleted.

    • domainId — (String)

      The ID of the Amazon DataZone domain in which the data source is deleted.

    • enableSetting — (String)

      The enable setting of the data source that specifies whether the data source is enabled or disabled.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • environmentId — (String)

      The ID of the environemnt associated with this data source.

    • errorMessage — (map)

      Specifies the error message that is returned if the operation cannot be successfully completed.

      • errorDetail — (String)

        The details of the error message that is returned if the operation cannot be successfully completed.

      • errorType — required — (String)

        The type of the error message that is returned if the operation cannot be successfully completed.

        Possible values include:
        • "ACCESS_DENIED_EXCEPTION"
        • "CONFLICT_EXCEPTION"
        • "INTERNAL_SERVER_EXCEPTION"
        • "RESOURCE_NOT_FOUND_EXCEPTION"
        • "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
        • "THROTTLING_EXCEPTION"
        • "VALIDATION_EXCEPTION"
    • id — (String)

      The ID of the data source that is deleted.

    • lastRunAt — (Date)

      The timestamp of when the data source was last run.

    • lastRunErrorMessage — (map)

      Specifies the error message that is returned if the operation cannot be successfully completed.

      • errorDetail — (String)

        The details of the error message that is returned if the operation cannot be successfully completed.

      • errorType — required — (String)

        The type of the error message that is returned if the operation cannot be successfully completed.

        Possible values include:
        • "ACCESS_DENIED_EXCEPTION"
        • "CONFLICT_EXCEPTION"
        • "INTERNAL_SERVER_EXCEPTION"
        • "RESOURCE_NOT_FOUND_EXCEPTION"
        • "SERVICE_QUOTA_EXCEEDED_EXCEPTION"
        • "THROTTLING_EXCEPTION"
        • "VALIDATION_EXCEPTION"
    • lastRunStatus — (String)

      The status of the last run of this data source.

      Possible values include:
      • "REQUESTED"
      • "RUNNING"
      • "FAILED"
      • "PARTIALLY_SUCCEEDED"
      • "SUCCESS"
    • name — (String)

      The name of the data source that is deleted.

    • projectId — (String)

      The ID of the project in which this data source exists and from which it's deleted.

    • publishOnImport — (Boolean)

      Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

    • schedule — (map)

      The schedule of runs for this data source.

      • schedule — (String)

        The schedule of the data source runs.

      • timezone — (String)

        The timezone of the data source run.

        Possible values include:
        • "UTC"
        • "AFRICA_JOHANNESBURG"
        • "AMERICA_MONTREAL"
        • "AMERICA_SAO_PAULO"
        • "ASIA_BAHRAIN"
        • "ASIA_BANGKOK"
        • "ASIA_CALCUTTA"
        • "ASIA_DUBAI"
        • "ASIA_HONG_KONG"
        • "ASIA_JAKARTA"
        • "ASIA_KUALA_LUMPUR"
        • "ASIA_SEOUL"
        • "ASIA_SHANGHAI"
        • "ASIA_SINGAPORE"
        • "ASIA_TAIPEI"
        • "ASIA_TOKYO"
        • "AUSTRALIA_MELBOURNE"
        • "AUSTRALIA_SYDNEY"
        • "CANADA_CENTRAL"
        • "CET"
        • "CST6CDT"
        • "ETC_GMT"
        • "ETC_GMT0"
        • "ETC_GMT_ADD_0"
        • "ETC_GMT_ADD_1"
        • "ETC_GMT_ADD_10"
        • "ETC_GMT_ADD_11"
        • "ETC_GMT_ADD_12"
        • "ETC_GMT_ADD_2"
        • "ETC_GMT_ADD_3"
        • "ETC_GMT_ADD_4"
        • "ETC_GMT_ADD_5"
        • "ETC_GMT_ADD_6"
        • "ETC_GMT_ADD_7"
        • "ETC_GMT_ADD_8"
        • "ETC_GMT_ADD_9"
        • "ETC_GMT_NEG_0"
        • "ETC_GMT_NEG_1"
        • "ETC_GMT_NEG_10"
        • "ETC_GMT_NEG_11"
        • "ETC_GMT_NEG_12"
        • "ETC_GMT_NEG_13"
        • "ETC_GMT_NEG_14"
        • "ETC_GMT_NEG_2"
        • "ETC_GMT_NEG_3"
        • "ETC_GMT_NEG_4"
        • "ETC_GMT_NEG_5"
        • "ETC_GMT_NEG_6"
        • "ETC_GMT_NEG_7"
        • "ETC_GMT_NEG_8"
        • "ETC_GMT_NEG_9"
        • "EUROPE_DUBLIN"
        • "EUROPE_LONDON"
        • "EUROPE_PARIS"
        • "EUROPE_STOCKHOLM"
        • "EUROPE_ZURICH"
        • "ISRAEL"
        • "MEXICO_GENERAL"
        • "MST7MDT"
        • "PACIFIC_AUCKLAND"
        • "US_CENTRAL"
        • "US_EASTERN"
        • "US_MOUNTAIN"
        • "US_PACIFIC"
    • status — (String)

      The status of this data source.

      Possible values include:
      • "CREATING"
      • "FAILED_CREATION"
      • "READY"
      • "UPDATING"
      • "FAILED_UPDATE"
      • "RUNNING"
      • "DELETING"
      • "FAILED_DELETION"
    • type — (String)

      The type of this data source.

    • updatedAt — (Date)

      The timestamp of when this data source was updated.

Returns:

• (AWS.Request) —

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

var params = {
  identifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  skipDeletionCheck: true || false
};
datazone.deleteDomain(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • identifier — (String)

    The identifier of the Amazon Web Services domain that is to be deleted.

  • skipDeletionCheck — (Boolean)

    Specifies the optional flag to delete all child entities within the domain.

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:

    • status — (String)

      The status of the domain.

      Possible values include:
      • "CREATING"
      • "AVAILABLE"
      • "CREATION_FAILED"
      • "DELETING"
      • "DELETED"
      • "DELETION_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteEnvironment(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the environment is deleted.

  • identifier — (String)

    The identifier of the environment that is to be deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentBlueprintIdentifier: 'STRING_VALUE' /* required */
};
datazone.deleteEnvironmentBlueprintConfiguration(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.

  • environmentBlueprintIdentifier — (String)

    The ID of the blueprint the configuration of which is deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteEnvironmentProfile(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the environment profile is deleted.

  • identifier — (String)

    The ID of the environment profile that is deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  formTypeIdentifier: 'STRING_VALUE' /* required */
};
datazone.deleteFormType(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the metadata form type is deleted.

  • formTypeIdentifier — (String)

    The ID of the metadata form type that is deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteGlossary(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the business glossary is deleted.

  • identifier — (String)

    The ID of the business glossary that is deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteGlossaryTerm(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain in which the business glossary term is deleted.

  • identifier — (String)

    The ID of the business glossary term that is deleted.

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.

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteListing(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: {}) —
  • domainIdentifier — (String)

    The ID of the Amazon DataZone domain.

  • identifier — (String)

    The ID of the listing to be deleted.