We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.DataZone

Inherits:
AWS.Service show all
Identifier:
datazone
API Version:
2018-05-10
Defined in:
(unknown)

Overview

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

Service Description

Amazon DataZone is a data management service that enables you to catalog, discover, govern, share, and analyze your data. With Amazon DataZone, you can share and access your data across accounts and supported regions. Amazon DataZone simplifies your experience across Amazon Web Services services, including, but not limited to, Amazon Redshift, Amazon Athena, Amazon Web Services Glue, and Amazon Web Services Lake Formation.

Sending a Request Using DataZone

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

Locking the API Version

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

var datazone = new AWS.DataZone({apiVersion: '2018-05-10'});

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

AWS.config.apiVersions = {
  datazone: '2018-05-10',
  // other service API versions
};

var datazone = new AWS.DataZone();

Version:

  • 2018-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a DataZone object

var datazone = new AWS.DataZone({apiVersion: '2018-05-10'});

Options Hash (options):

  • params (map)

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

  • endpoint (String|AWS.Endpoint)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Accepts automatically generated business-friendly metadata for your Amazon DataZone assets.

Service Reference:

Examples:

Calling the acceptPredictions operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  acceptChoices: [
    {
      predictionTarget: 'STRING_VALUE', /* required */
      editedValue: 'STRING_VALUE',
      predictionChoice: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  acceptRule: {
    rule: ALL | NONE,
    threshold: 'NUMBER_VALUE'
  },
  clientToken: 'STRING_VALUE',
  revision: 'STRING_VALUE'
};
datazone.acceptPredictions(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: {})
    • acceptChoices — (Array<map>)

      Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be accepted.

      • editedValue — (String)

        The edit of the prediction.

      • predictionChoice — (Integer)

        Specifies the prediction (aka, the automatically generated piece of metadata) that can be accepted.

      • predictionTargetrequired — (String)

        Specifies the target (for example, a column name) where a prediction can be accepted.

    • acceptRule — (map)

      Specifies the rule (or the conditions) under which a prediction can be accepted.

      • rule — (String)

        Specifies whether you want to accept the top prediction for all targets or none.

        Possible values include:
        • "ALL"
        • "NONE"
      • threshold — (Float)

        The confidence score that specifies the condition at which a prediction can be accepted.

    • clientToken — (String)

      A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

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

      The identifier of the Amazon DataZone domain.

    • identifier — (String)

      The identifier of the asset.

    • revision — (String)

      The revision that is to be made to 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:

      • assetId — (String)

        The ID of the asset.

      • domainId — (String)

        The identifier of the Amazon DataZone domain.

      • revision — (String)

        The revision that is to be made to the asset.

Returns:

  • (AWS.Request)

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

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

Accepts a subscription request to a specific asset.

Service Reference:

Examples:

Calling the acceptSubscriptionRequest operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  assetScopes: [
    {
      assetId: 'STRING_VALUE', /* required */
      filterIds: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  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: {})
    • assetScopes — (Array<map>)

      The asset scopes of the accept subscription request.

      • assetIdrequired — (String)

        The asset ID of the accepted asset scope.

      • filterIdsrequired — (Array<String>)

        The filter IDs of the accepted asset scope.

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

        • descriptionrequired — (String)

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

        • idrequired — (String)

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

        • itemrequired — (map)

          The published asset for which the subscription grant is created.

          • assetListing — (map)

            The asset for which the subscription grant is created.

            • assetScope — (map)

              The asset scope of the subscribed asset listing.

              • assetIdrequired — (String)

                The asset ID of the asset scope.

              • errorMessage — (String)

                The error message of the asset scope.

              • filterIdsrequired — (Array<String>)

                The filter IDs of the asset scope.

              • statusrequired — (String)

                The status of the asset scope.

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

          • productListing — (map)

            The data product listing.

            • assetListings — (Array<map>)

              The data assets of the data product listing.

              • entityId — (String)

                The entity ID of the listing of the asset in a data product.

              • entityRevision — (String)

                The entity revision of the listing of the asset in a data product.

              • entityType — (String)

                The entity type of the listing of the asset in a data product.

            • description — (String)

              The description of the data product listing.

            • entityId — (String)

              The ID of the data product listing.

            • entityRevision — (String)

              The revision of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product listing.

              • 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 — (String)

              The name of the data product listing.

        • namerequired — (String)

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

        • ownerProjectIdrequired — (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.

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

Adds the owner of an entity (a domain unit).

Service Reference:

Examples:

Calling the addEntityOwner operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: DOMAIN_UNIT, /* required */
  owner: { /* required */
    group: {
      groupIdentifier: 'STRING_VALUE' /* required */
    },
    user: {
      userIdentifier: 'STRING_VALUE' /* required */
    }
  },
  clientToken: 'STRING_VALUE'
};
datazone.addEntityOwner(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 domain in which you want to add the entity owner.

    • entityIdentifier — (String)

      The ID of the entity to which you want to add an owner.

    • entityType — (String)

      The type of an entity.

      Possible values include:
      • "DOMAIN_UNIT"
    • owner — (map)

      The owner that you want to add to the entity.

      • group — (map)

        Specifies that the domain unit owner is a group.

        • groupIdentifierrequired — (String)

          The ID of the domain unit owners group.

      • user — (map)

        Specifies that the domain unit owner is a user.

        • userIdentifierrequired — (String)

          The ID of the owner 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.

Returns:

  • (AWS.Request)

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

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

Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.

Service Reference:

Examples:

Calling the addPolicyGrant operation

var params = {
  detail: { /* required */
    addToProjectMemberPool: {
      includeChildDomainUnits: true || false
    },
    createAssetType: {
      includeChildDomainUnits: true || false
    },
    createDomainUnit: {
      includeChildDomainUnits: true || false
    },
    createEnvironment: {
    },
    createEnvironmentProfile: {
      domainUnitId: 'STRING_VALUE'
    },
    createFormType: {
      includeChildDomainUnits: true || false
    },
    createGlossary: {
      includeChildDomainUnits: true || false
    },
    createProject: {
      includeChildDomainUnits: true || false
    },
    delegateCreateEnvironmentProfile: {
    },
    overrideDomainUnitOwners: {
      includeChildDomainUnits: true || false
    },
    overrideProjectOwners: {
      includeChildDomainUnits: true || false
    }
  },
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE, /* required */
  policyType: CREATE_DOMAIN_UNIT | OVERRIDE_DOMAIN_UNIT_OWNERS | ADD_TO_PROJECT_MEMBER_POOL | OVERRIDE_PROJECT_OWNERS | CREATE_GLOSSARY | CREATE_FORM_TYPE | CREATE_ASSET_TYPE | CREATE_PROJECT | CREATE_ENVIRONMENT_PROFILE | DELEGATE_CREATE_ENVIRONMENT_PROFILE | CREATE_ENVIRONMENT, /* required */
  principal: { /* required */
    domainUnit: {
      domainUnitDesignation: OWNER, /* required */
      domainUnitGrantFilter: {
        allDomainUnitsGrantFilter: {
        }
      },
      domainUnitIdentifier: 'STRING_VALUE'
    },
    group: {
      groupIdentifier: 'STRING_VALUE'
    },
    project: {
      projectDesignation: OWNER | CONTRIBUTOR, /* required */
      projectGrantFilter: {
        domainUnitFilter: {
          domainUnit: 'STRING_VALUE', /* required */
          includeChildDomainUnits: true || false
        }
      },
      projectIdentifier: 'STRING_VALUE'
    },
    user: {
      allUsersGrantFilter: {
      },
      userIdentifier: 'STRING_VALUE'
    }
  },
  clientToken: 'STRING_VALUE'
};
datazone.addPolicyGrant(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.
    • detail — (map)

      The details of the policy grant.

      • addToProjectMemberPool — (map)

        Specifies that the policy grant is to be added to the members of the project.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy grant is applied to child domain units.

      • createAssetType — (map)

        Specifies that this is a create asset type policy.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy grant is applied to child domain units.

      • createDomainUnit — (map)

        Specifies that this is a create domain unit policy.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy grant is applied to child domain units.

      • createEnvironment — (map)

        Specifies that this is a create environment policy.

      • createEnvironmentProfile — (map)

        Specifies that this is a create environment profile policy.

        • domainUnitId — (String)

          The ID of the domain unit.

      • createFormType — (map)

        Specifies that this is a create form type policy.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy grant is applied to child domain units.

      • createGlossary — (map)

        Specifies that this is a create glossary policy.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy grant is applied to child domain units.

      • createProject — (map)

        Specifies that this is a create project policy.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy grant is applied to child domain units.

      • delegateCreateEnvironmentProfile — (map)

        Specifies that this is the delegation of the create environment profile policy.

      • overrideDomainUnitOwners — (map)

        Specifies whether to override domain unit owners.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy is inherited by child domain units.

      • overrideProjectOwners — (map)

        Specifies whether to override project owners.

        • includeChildDomainUnits — (Boolean)

          Specifies whether the policy is inherited by child domain units.

    • domainIdentifier — (String)

      The ID of the domain where you want to add a policy grant.

    • entityIdentifier — (String)

      The ID of the entity (resource) to which you want to add a policy grant.

    • entityType — (String)

      The type of entity (resource) to which the grant is added.

      Possible values include:
      • "DOMAIN_UNIT"
      • "ENVIRONMENT_BLUEPRINT_CONFIGURATION"
      • "ENVIRONMENT_PROFILE"
    • policyType — (String)

      The type of policy that you want to grant.

      Possible values include:
      • "CREATE_DOMAIN_UNIT"
      • "OVERRIDE_DOMAIN_UNIT_OWNERS"
      • "ADD_TO_PROJECT_MEMBER_POOL"
      • "OVERRIDE_PROJECT_OWNERS"
      • "CREATE_GLOSSARY"
      • "CREATE_FORM_TYPE"
      • "CREATE_ASSET_TYPE"
      • "CREATE_PROJECT"
      • "CREATE_ENVIRONMENT_PROFILE"
      • "DELEGATE_CREATE_ENVIRONMENT_PROFILE"
      • "CREATE_ENVIRONMENT"
    • principal — (map)

      The principal to whom the permissions are granted.

      • domainUnit — (map)

        The domain unit of the policy grant principal.

        • domainUnitDesignationrequired — (String)

          Specifes the designation of the domain unit users.

          Possible values include:
          • "OWNER"
        • domainUnitGrantFilter — (map)

          The grant filter for the domain unit.

          • allDomainUnitsGrantFilter — (map)

            Specifies a grant filter containing all domain units.

        • domainUnitIdentifier — (String)

          The ID of the domain unit.

      • group — (map)

        The group of the policy grant principal.

        • groupIdentifier — (String)

          The ID Of the group of the group principal.

      • project — (map)

        The project of the policy grant principal.

        • projectDesignationrequired — (String)

          The project designation of the project policy grant principal.

          Possible values include:
          • "OWNER"
          • "CONTRIBUTOR"
        • projectGrantFilter — (map)

          The project grant filter of the project policy grant principal.

          • domainUnitFilter — (map)

            The domain unit filter of the project grant filter.

            • domainUnitrequired — (String)

              The domain unit ID to use in the filter.

            • includeChildDomainUnits — (Boolean)

              Specifies whether to include child domain units.

        • projectIdentifier — (String)

          The project ID of the project policy grant principal.

      • user — (map)

        The user of the policy grant principal.

        • allUsersGrantFilter — (map)

          The all users grant filter of the user policy grant principal.

        • userIdentifier — (String)

          The user ID of the user policy grant principal.

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.

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

Associates the environment role in Amazon DataZone.

Service Reference:

Examples:

Calling the associateEnvironmentRole operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  environmentRoleArn: 'STRING_VALUE' /* required */
};
datazone.associateEnvironmentRole(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 role is associated.

    • environmentIdentifier — (String)

      The ID of the Amazon DataZone environment.

    • environmentRoleArn — (String)

      The ARN of the environment role.

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.

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

Cancels the metadata generation run.

Service Reference:

Examples:

Calling the cancelMetadataGenerationRun operation

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.

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

Cancels the subscription to the specified asset.

Service Reference:

Examples:

Calling the cancelSubscription operation

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.

        • descriptionrequired — (String)

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

        • idrequired — (String)

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

        • itemrequired — (map)

          The published asset for which the subscription grant is created.

          • assetListing — (map)

            The asset for which the subscription grant is created.

            • assetScope — (map)

              The asset scope of the subscribed asset listing.

              • assetIdrequired — (String)

                The asset ID of the asset scope.

              • errorMessage — (String)

                The error message of the asset scope.

              • filterIdsrequired — (Array<String>)

                The filter IDs of the asset scope.

              • statusrequired — (String)

                The status of the asset scope.

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

          • productListing — (map)

            The data product listing.

            • assetListings — (Array<map>)

              The data assets of the data product listing.

              • entityId — (String)

                The entity ID of the listing of the asset in a data product.

              • entityRevision — (String)

                The entity revision of the listing of the asset in a data product.

              • entityType — (String)

                The entity type of the listing of the asset in a data product.

            • description — (String)

              The description of the data product listing.

            • entityId — (String)

              The ID of the data product listing.

            • entityRevision — (String)

              The revision of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product listing.

              • 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 — (String)

              The name of the data product listing.

        • namerequired — (String)

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

        • ownerProjectIdrequired — (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.

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

Creates an asset in Amazon DataZone catalog.

Service Reference:

Examples:

Calling the createAsset operation

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.

      • formNamerequired — (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.

        • formNamerequired — (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.

        • formNamerequired — (String)

          The name of the time series data points summary form.

        • id — (String)

          The ID of the time series data points summary form.

        • timestamprequired — (Date)

          The timestamp of the time series data points summary form.

        • typeIdentifierrequired — (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.

        • listingIdrequired — (String)

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

        • listingStatusrequired — (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.

        • formNamerequired — (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.

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

Creates a data asset filter.

Service Reference:

Examples:

Calling the createAssetFilter operation

var params = {
  assetIdentifier: 'STRING_VALUE', /* required */
  configuration: { /* required */
    columnConfiguration: {
      includedColumnNames: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    rowConfiguration: {
      rowFilter: { /* RowFilter */ /* required */
        and: [
          /* recursive RowFilter */,
          /* more items */
        ],
        expression: {
          equalTo: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          greaterThan: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          greaterThanOrEqualTo: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          in: {
            columnName: 'STRING_VALUE', /* required */
            values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          isNotNull: {
            columnName: 'STRING_VALUE' /* required */
          },
          isNull: {
            columnName: 'STRING_VALUE' /* required */
          },
          lessThan: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          lessThanOrEqualTo: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          like: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          notEqualTo: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          },
          notIn: {
            columnName: 'STRING_VALUE', /* required */
            values: [ /* required */
              'STRING_VALUE',
              /* more items */
            ]
          },
          notLike: {
            columnName: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE' /* required */
          }
        },
        or: [
          /* recursive RowFilter */,
          /* more items */
        ]
      },
      sensitive: true || false
    }
  },
  domainIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
datazone.createAssetFilter(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: {})
    • assetIdentifier — (String)

      The ID of the data asset.

    • 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)

      The configuration of the asset filter.

      • columnConfiguration — (map)

        The column configuration of the asset filter.

        • includedColumnNames — (Array<String>)

          Specifies whether to include column names.

      • rowConfiguration — (map)

        The row configuration of the asset filter.

        • rowFilterrequired — (map)

          The row filter.

          • and — (Array<map>)

            The 'and' clause of the row filter.

          • expression — (map)

            The expression of the row filter.

            • equalTo — (map)

              The 'equal to' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might be equal to an expression.

            • greaterThan — (map)

              The 'greater than' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might be greater than an expression.

            • greaterThanOrEqualTo — (map)

              The 'greater than or equal to' clause of the filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might be greater than or equal to an expression.

            • in — (map)

              The 'in' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuesrequired — (Array<String>)

                The values that might be in the expression.

            • isNotNull — (map)

              The 'is not null' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

            • isNull — (map)

              The 'is null' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

            • lessThan — (map)

              The 'less than' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might be less than the expression.

            • lessThanOrEqualTo — (map)

              The 'less than or equal to' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might be less than or equal to an expression.

            • like — (map)

              The 'like' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might be like the expression.

            • notEqualTo — (map)

              The 'no equal to' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might not be equal to the expression.

            • notIn — (map)

              The 'not in' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuesrequired — (Array<String>)

                The value that might not be in the expression.

            • notLike — (map)

              The 'not like' clause of the row filter expression.

              • columnNamerequired — (String)

                The name of the column.

              • valuerequired — (String)

                The value that might not be like the expression.

          • or — (Array<map>)

            The 'or' clause of the row filter.

        • sensitive — (Boolean)

          Specifies whether the row filter is sensitive.

    • description — (String)

      The description of the asset filter.

    • domainIdentifier — (String)

      The ID of the domain in which you want to create an asset filter.

    • name — (String)

      The name of the asset filter.

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:

      • assetId — (String)

        The ID of the asset.

      • configuration — (map)

        The configuration of the asset filter.

        • columnConfiguration — (map)

          The column configuration of the asset filter.

          • includedColumnNames — (Array<String>)

            Specifies whether to include column names.

        • rowConfiguration — (map)

          The row configuration of the asset filter.

          • rowFilterrequired — (map)

            The row filter.

            • and — (Array<map>)

              The 'and' clause of the row filter.

            • expression — (map)

              The expression of the row filter.

              • equalTo — (map)

                The 'equal to' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be equal to an expression.

              • greaterThan — (map)

                The 'greater than' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be greater than an expression.

              • greaterThanOrEqualTo — (map)

                The 'greater than or equal to' clause of the filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be greater than or equal to an expression.

              • in — (map)

                The 'in' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuesrequired — (Array<String>)

                  The values that might be in the expression.

              • isNotNull — (map)

                The 'is not null' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

              • isNull — (map)

                The 'is null' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

              • lessThan — (map)

                The 'less than' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be less than the expression.

              • lessThanOrEqualTo — (map)

                The 'less than or equal to' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be less than or equal to an expression.

              • like — (map)

                The 'like' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be like the expression.

              • notEqualTo — (map)

                The 'no equal to' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might not be equal to the expression.

              • notIn — (map)

                The 'not in' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuesrequired — (Array<String>)

                  The value that might not be in the expression.

              • notLike — (map)

                The 'not like' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might not be like the expression.

            • or — (Array<map>)

              The 'or' clause of the row filter.

          • sensitive — (Boolean)

            Specifies whether the row filter is sensitive.

      • createdAt — (Date)

        The timestamp at which the asset filter was created.

      • description — (String)

        The description of the asset filter.

      • domainId — (String)

        The ID of the domain where the asset filter is created.

      • effectiveColumnNames — (Array<String>)

        The column names in the asset filter.

      • effectiveRowFilter — (String)

        The row filter in the asset filter.

      • errorMessage — (String)

        The error message that is displayed if the asset filter is not created successfully.

      • id — (String)

        The ID of the asset filter.

      • name — (String)

        The name of the asset filter.

      • status — (String)

        The status of the asset filter.

        Possible values include:
        • "VALID"
        • "INVALID"

Returns:

  • (AWS.Request)

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

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

Creates a revision of the asset.

Service Reference:

Examples:

Calling the createAssetRevision operation

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.

      • formNamerequired — (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.

        • formNamerequired — (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.

        • formNamerequired — (String)

          The name of the time series data points summary form.

        • id — (String)

          The ID of the time series data points summary form.

        • timestamprequired — (Date)

          The timestamp of the time series data points summary form.

        • typeIdentifierrequired — (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.

        • listingIdrequired — (String)

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

        • listingStatusrequired — (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.

        • formNamerequired — (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.

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

Creates a custom asset type.

Service Reference:

Examples:

Calling the createAssetType operation

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.

      • typeIdentifierrequired — (String)

        The type ID of the form entry.

      • typeRevisionrequired — (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.

        • typeNamerequired — (String)

          The name of the type of the form entry.

        • typeRevisionrequired — (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.

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

Creates a data product.

Service Reference:

Examples:

Calling the createDataProduct operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  owningProjectIdentifier: '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 */
  ],
  items: [
    {
      identifier: 'STRING_VALUE', /* required */
      itemType: ASSET, /* required */
      glossaryTerms: [
        'STRING_VALUE',
        /* more items */
      ],
      revision: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datazone.createDataProduct(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 data product.

    • domainIdentifier — (String)

      The ID of the domain where the data product is created.

    • formsInput — (Array<map>)

      The metadata forms of the data product.

      • content — (String)

        The content of the metadata form.

      • formNamerequired — (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 of the data product.

    • items — (Array<map>)

      The data assets of the data product.

      • glossaryTerms — (Array<String>)

        The glossary terms of the data product.

      • identifierrequired — (String)

        The ID of the data product.

      • itemTyperequired — (String)

        The type of the data product.

        Possible values include:
        • "ASSET"
      • revision — (String)

        The revision of the data product.

    • name — (String)

      The name of the data product.

    • owningProjectIdentifier — (String)

      The ID of the owning project of the data product.

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 at which the data product was created.

      • createdBy — (String)

        The user who created the data product.

      • description — (String)

        The description of the data product.

      • domainId — (String)

        The ID of the domain where the data product lives.

      • firstRevisionCreatedAt — (Date)

        The timestamp at which the first revision of the data product was created.

      • firstRevisionCreatedBy — (String)

        The user who created the first revision of the data product.

      • formsOutput — (Array<map>)

        The metadata forms of the data product.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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 of the data product.

      • id — (String)

        The ID of the data product.

      • items — (Array<map>)

        The data assets of the data product.

        • glossaryTerms — (Array<String>)

          The glossary terms of the data product.

        • identifierrequired — (String)

          The ID of the data product.

        • itemTyperequired — (String)

          The type of the data product.

          Possible values include:
          • "ASSET"
        • revision — (String)

          The revision of the data product.

      • name — (String)

        The name of the data product.

      • owningProjectId — (String)

        The ID of the owning project of the data product.

      • revision — (String)

        The revision of the data product.

      • status — (String)

        The status of the data product.

        Possible values include:
        • "CREATED"
        • "CREATING"
        • "CREATE_FAILED"

Returns:

  • (AWS.Request)

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

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

Creates a data product revision.

Service Reference:

Examples:

Calling the createDataProductRevision operation

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 */
  ],
  items: [
    {
      identifier: 'STRING_VALUE', /* required */
      itemType: ASSET, /* required */
      glossaryTerms: [
        'STRING_VALUE',
        /* more items */
      ],
      revision: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datazone.createDataProductRevision(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 data product revision.

    • domainIdentifier — (String)

      The ID of the domain where the data product revision is created.

    • formsInput — (Array<map>)

      The metadata forms of the data product revision.

      • content — (String)

        The content of the metadata form.

      • formNamerequired — (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 of the data product revision.

    • identifier — (String)

      The ID of the data product revision.

    • items — (Array<map>)

      The data assets of the data product revision.

      • glossaryTerms — (Array<String>)

        The glossary terms of the data product.

      • identifierrequired — (String)

        The ID of the data product.

      • itemTyperequired — (String)

        The type of the data product.

        Possible values include:
        • "ASSET"
      • revision — (String)

        The revision of the data product.

    • name — (String)

      The name of the data product revision.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • createdAt — (Date)

        The timestamp at which the data product revision is created.

      • createdBy — (String)

        The user who created the data product revision.

      • description — (String)

        The description of the data product revision.

      • domainId — (String)

        The ID of the domain where data product revision is created.

      • firstRevisionCreatedAt — (Date)

        The timestamp at which the first revision of the data product is created.

      • firstRevisionCreatedBy — (String)

        The user who created the first revision of the data product.

      • formsOutput — (Array<map>)

        The metadata forms of the data product revision.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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 of the data product revision.

      • id — (String)

        The ID of the data product revision.

      • items — (Array<map>)

        The data assets of the data product revision.

        • glossaryTerms — (Array<String>)

          The glossary terms of the data product.

        • identifierrequired — (String)

          The ID of the data product.

        • itemTyperequired — (String)

          The type of the data product.

          Possible values include:
          • "ASSET"
        • revision — (String)

          The revision of the data product.

      • name — (String)

        The name of the data product revision.

      • owningProjectId — (String)

        The ID of the owning project of the data product revision.

      • revision — (String)

        The revision of the data product revision.

      • status — (String)

        The status of the data product revision.

        Possible values include:
        • "CREATED"
        • "CREATING"
        • "CREATE_FAILED"

Returns:

  • (AWS.Request)

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

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

Creates an Amazon DataZone data source.

Service Reference:

Examples:

Calling the createDataSource operation

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.

      • formNamerequired — (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.

        • relationalFilterConfigurationsrequired — (Array<map>)

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

          • databaseNamerequired — (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.

            • expressionrequired — (String)

              The search filter expression.

            • typerequired — (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.

        • redshiftCredentialConfigurationrequired — (map)

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

          • secretManagerArnrequired — (String)

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

        • redshiftStoragerequired — (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.

            • clusterNamerequired — (String)

              The name of an Amazon Redshift cluster.

          • redshiftServerlessSource — (map)

            The details of the Amazon Redshift Serverless workgroup source.

            • workgroupNamerequired — (String)

              The name of the Amazon Redshift Serverless workgroup.

        • relationalFilterConfigurationsrequired — (Array<map>)

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

          • databaseNamerequired — (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.

            • expressionrequired — (String)

              The search filter expression.

            • typerequired — (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.

        • formNamerequired — (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.

          • relationalFilterConfigurationsrequired — (Array<map>)

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

            • databaseNamerequired — (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.

              • expressionrequired — (String)

                The search filter expression.

              • typerequired — (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.

          • redshiftCredentialConfigurationrequired — (map)

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

            • secretManagerArnrequired — (String)

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

          • redshiftStoragerequired — (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.

              • clusterNamerequired — (String)

                The name of an Amazon Redshift cluster.

            • redshiftServerlessSource — (map)

              The details of the Amazon Redshift Serverless workgroup source.

              • workgroupNamerequired — (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.

          • relationalFilterConfigurationsrequired — (Array<map>)

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

            • databaseNamerequired — (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.

              • expressionrequired — (String)

                The search filter expression.

              • typerequired — (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.

        • errorTyperequired — (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.

        • errorTyperequired — (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.

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

Creates an Amazon DataZone domain.

Service Reference:

Examples:

Calling the createDomain operation

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.

      • rootDomainUnitId — (String)

        The ID of the root domain unit.

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

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

Creates a domain unit in Amazon DataZone.

Service Reference:

Examples:

Calling the createDomainUnit operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  parentDomainUnitIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
datazone.createDomainUnit(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 domain unit.

    • domainIdentifier — (String)

      The ID of the domain where you want to crate a domain unit.

    • name — (String)

      The name of the domain unit.

    • parentDomainUnitIdentifier — (String)

      The ID of the parent domain unit.

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:

      • ancestorDomainUnitIds — (Array<String>)

        The IDs of the ancestor domain units.

      • createdAt — (Date)

        The timestamp at which the domain unit was created.

      • createdBy — (String)

        The user who created the domain unit.

      • description — (String)

        The description of the domain unit.

      • domainId — (String)

        The ID of the domain where the domain unit was created.

      • id — (String)

        The ID of the domain unit.

      • name — (String)

        The name of the domain unit.

      • owners — (Array<map>)

        The owners of the domain unit.

        • group — (map)

          Indicates that the domain unit owner is a group.

          • groupId — (String)

            The ID of the domain unit group.

        • user — (map)

          Indicates that the domain unit owner is a user.

          • userId — (String)

            The ID of teh domain unit user.

      • parentDomainUnitId — (String)

        The ID of the parent domain unit.

Returns:

  • (AWS.Request)

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

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

Create an Amazon DataZone environment.

Service Reference:

Examples:

Calling the createEnvironment operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentProfileIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  projectIdentifier: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  environmentAccountIdentifier: 'STRING_VALUE',
  environmentAccountRegion: 'STRING_VALUE',
  environmentBlueprintIdentifier: '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.

    • environmentAccountIdentifier — (String)

      The ID of the account in which the environment is being created.

    • environmentAccountRegion — (String)

      The region of the account in which the environment is being created.

    • environmentBlueprintIdentifier — (String)

      The ID of the blueprint with which the environment is being 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"
        • parametersrequired — (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.

        • typerequired — (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.

          • messagerequired — (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.

        • typerequired — (String)

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

        • valuerequired — (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.

          • templateUrlrequired — (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.

        • fieldTyperequired — (String)

          The filed type of the parameter.

        • isEditable — (Boolean)

          Specifies whether the parameter is editable.

        • isOptional — (Boolean)

          Specifies whether the custom parameter is optional.

        • keyNamerequired — (String)

          The key name of the parameter.

Returns:

  • (AWS.Request)

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

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

Creates an action for the environment, for example, creates a console link for an analytics tool that is available in this environment.

Service Reference:

Examples:

Calling the createEnvironmentAction operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  parameters: { /* required */
    awsConsoleLink: {
      uri: 'STRING_VALUE'
    }
  },
  description: 'STRING_VALUE'
};
datazone.createEnvironmentAction(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 environment action that is being created in the environment.

    • domainIdentifier — (String)

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

    • environmentIdentifier — (String)

      The ID of the environment in which the environment action is created.

    • name — (String)

      The name of the environment action.

    • parameters — (map)

      The parameters of the environment action.

      • awsConsoleLink — (map)

        The console link specified as part of the environment action.

        • uri — (String)

          The URI of the console link specified as part of the environment action.

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 the environment action.

      • domainId — (String)

        The ID of the domain in which the environment action is created.

      • environmentId — (String)

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

      • id — (String)

        The ID of the environment action.

      • name — (String)

        The name of the environment action.

      • parameters — (map)

        The parameters of the environment action.

        • awsConsoleLink — (map)

          The console link specified as part of the environment action.

          • uri — (String)

            The URI of the console link specified as part of the environment action.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon DataZone environment profile.

Service Reference:

Examples:

Calling the createEnvironmentProfile operation

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.

        • fieldTyperequired — (String)

          The filed type of the parameter.

        • isEditable — (Boolean)

          Specifies whether the parameter is editable.

        • isOptional — (Boolean)

          Specifies whether the custom parameter is optional.

        • keyNamerequired — (String)

          The key name of the parameter.

Returns:

  • (AWS.Request)

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

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

Creates a metadata form type.

Service Reference:

Examples:

Calling the createFormType operation

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.

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

Creates an Amazon DataZone business glossary.

Service Reference:

Examples:

Calling the createGlossary operation

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.

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

Creates a business glossary term.

Service Reference:

Examples:

Calling the createGlossaryTerm operation

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.

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

Creates a group profile in Amazon DataZone.

Service Reference:

Examples:

Calling the createGroupProfile operation

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.

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

Publishes a listing (a record of an asset at a given time) or removes a listing from the catalog.

Service Reference:

Examples:

Calling the createListingChangeSet operation

var params = {
  action: PUBLISH | UNPUBLISH, /* required */
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: ASSET | DATA_PRODUCT, /* 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"
      • "DATA_PRODUCT"

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.

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

Creates an Amazon DataZone project.

Service Reference:

Examples:

Calling the createProject operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  domainUnitId: '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.

    • domainUnitId — (String)

      The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

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

      • domainUnitId — (String)

        The ID of the domain unit.

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

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

Creates a project membership in Amazon DataZone.

Service Reference:

Examples:

Calling the createProjectMembership operation

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.

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

Creates a subsscription grant in Amazon DataZone.

Service Reference:

Examples:

Calling the createSubscriptionGrant operation

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.

      • assetIdrequired — (String)

        The identifier of the inventory asset.

      • targetNamerequired — (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.

        • identifierrequired — (String)

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

        • revisionrequired — (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.

        • assetIdrequired — (String)

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

        • assetRevisionrequired — (String)

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

        • assetScope — (map)

          The asset scope of the subscribed asset.

          • assetIdrequired — (String)

            The asset ID of the asset scope.

          • errorMessage — (String)

            The error message of the asset scope.

          • filterIdsrequired — (Array<String>)

            The filter IDs of the asset scope.

          • statusrequired — (String)

            The status of the asset scope.

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

        • statusrequired — (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.

          • idrequired — (String)

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

          • revisionrequired — (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.

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

Creates a subscription request in Amazon DataZone.

Service Reference:

Examples:

Calling the createSubscriptionRequest operation

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.

      • identifierrequired — (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.

        • descriptionrequired — (String)

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

        • idrequired — (String)

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

        • itemrequired — (map)

          The published asset for which the subscription grant is created.

          • assetListing — (map)

            The asset for which the subscription grant is created.

            • assetScope — (map)

              The asset scope of the subscribed asset listing.

              • assetIdrequired — (String)

                The asset ID of the asset scope.

              • errorMessage — (String)

                The error message of the asset scope.

              • filterIdsrequired — (Array<String>)

                The filter IDs of the asset scope.

              • statusrequired — (String)

                The status of the asset scope.

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

          • productListing — (map)

            The data product listing.

            • assetListings — (Array<map>)

              The data assets of the data product listing.

              • entityId — (String)

                The entity ID of the listing of the asset in a data product.

              • entityRevision — (String)

                The entity revision of the listing of the asset in a data product.

              • entityType — (String)

                The entity type of the listing of the asset in a data product.

            • description — (String)

              The description of the data product listing.

            • entityId — (String)

              The ID of the data product listing.

            • entityRevision — (String)

              The revision of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product listing.

              • 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 — (String)

              The name of the data product listing.

        • namerequired — (String)

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

        • ownerProjectIdrequired — (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.

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

Creates a subscription target in Amazon DataZone.

Service Reference:

Examples:

Calling the createSubscriptionTarget operation

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.

      • contentrequired — (String)

        The content of the subscription target configuration.

      • formNamerequired — (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.

        • contentrequired — (String)

          The content of the subscription target configuration.

        • formNamerequired — (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.

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

Creates a user profile in Amazon DataZone.

Service Reference:

Examples:

Calling the createUserProfile operation

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.

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

Deletes an asset in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteAsset operation

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.

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

Deletes an asset filter.

Service Reference:

Examples:

Calling the deleteAssetFilter operation

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

      The ID of the data asset.

    • domainIdentifier — (String)

      The ID of the domain where you want to delete an asset filter.

    • identifier — (String)

      The ID of the asset filter that you want to delete.

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.

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

Deletes an asset type in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteAssetType operation

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.

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

Deletes a data product in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteDataProduct operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteDataProduct(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 data product is deleted.

    • identifier — (String)

      The identifier of the data product 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.

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

Deletes a data source in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteDataSource operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  retainPermissionsOnRevokeFailure: true || false
};
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.

    • retainPermissionsOnRevokeFailure — (Boolean)

      Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a 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 asset data forms associated with this data source.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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.

          • relationalFilterConfigurationsrequired — (Array<map>)

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

            • databaseNamerequired — (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.

              • expressionrequired — (String)

                The search filter expression.

              • typerequired — (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.

          • redshiftCredentialConfigurationrequired — (map)

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

            • secretManagerArnrequired — (String)

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

          • redshiftStoragerequired — (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.

              • clusterNamerequired — (String)

                The name of an Amazon Redshift cluster.

            • redshiftServerlessSource — (map)

              The details of the Amazon Redshift Serverless workgroup source.

              • workgroupNamerequired — (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.

          • relationalFilterConfigurationsrequired — (Array<map>)

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

            • databaseNamerequired — (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.

              • expressionrequired — (String)

                The search filter expression.

              • typerequired — (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.

        • errorTyperequired — (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.

        • errorTyperequired — (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.

      • retainPermissionsOnRevokeFailure — (Boolean)

        Specifies that the granted permissions are retained in case of a self-subscribe functionality failure for a data source.

      • 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"
      • selfGrantStatus — (map)

        Specifies the status of the self-granting functionality.

        • glueSelfGrantStatus — (map)

          The details for the self granting status for a Glue data source.

          • selfGrantStatusDetailsrequired — (Array<map>)

            The details for the self granting status for a Glue data source.

            • databaseNamerequired — (String)

              The name of the database used for the data source.

            • failureCause — (String)

              The reason for why the operation failed.

            • schemaName — (String)

              The name of the schema used in the data source.

            • statusrequired — (String)

              The self granting status of the data source.

              Possible values include:
              • "GRANT_PENDING"
              • "REVOKE_PENDING"
              • "GRANT_IN_PROGRESS"
              • "REVOKE_IN_PROGRESS"
              • "GRANTED"
              • "GRANT_FAILED"
              • "REVOKE_FAILED"
        • redshiftSelfGrantStatus — (map)

          The details for the self granting status for an Amazon Redshift data source.

          • selfGrantStatusDetailsrequired — (Array<map>)

            The details for the self granting status for an Amazon Redshift data source.

            • databaseNamerequired — (String)

              The name of the database used for the data source.

            • failureCause — (String)

              The reason for why the operation failed.

            • schemaName — (String)

              The name of the schema used in the data source.

            • statusrequired — (String)

              The self granting status of the data source.

              Possible values include:
              • "GRANT_PENDING"
              • "REVOKE_PENDING"
              • "GRANT_IN_PROGRESS"
              • "REVOKE_IN_PROGRESS"
              • "GRANTED"
              • "GRANT_FAILED"
              • "REVOKE_FAILED"
      • 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.

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

Deletes a Amazon DataZone domain.

Service Reference:

Examples:

Calling the deleteDomain operation

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.

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

Deletes a domain unit.

Service Reference:

Examples:

Calling the deleteDomainUnit operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteDomainUnit(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 domain where you want to delete a domain unit.

    • identifier — (String)

      The ID of the domain unit that you want to delete.

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.

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

Deletes an environment in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteEnvironment operation

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.

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

Deletes an action for the environment, for example, deletes a console link for an analytics tool that is available in this environment.

Service Reference:

Examples:

Calling the deleteEnvironmentAction operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteEnvironmentAction(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 an environment action is deleted.

    • environmentIdentifier — (String)

      The ID of the environment where an environment action is deleted.

    • identifier — (String)

      The ID of the environment action 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.

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

Deletes the blueprint configuration in Amazon DataZone.

Examples:

Calling the deleteEnvironmentBlueprintConfiguration operation

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.

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

Deletes an environment profile in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteEnvironmentProfile operation

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.

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

Delets and metadata form type in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteFormType operation

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.

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

Deletes a business glossary in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteGlossary operation

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.

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

Deletes a business glossary term in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteGlossaryTerm operation

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.

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

Deletes a listing (a record of an asset at a given time).

Service Reference:

Examples:

Calling the deleteListing operation

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.

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.

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

Deletes a project in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteProject operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  skipDeletionCheck: true || false
};
datazone.deleteProject(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 project is deleted.

    • identifier — (String)

      The identifier of the project that is to be deleted.

    • skipDeletionCheck — (Boolean)

      Specifies the optional flag to delete all child entities within the 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.

Returns:

  • (AWS.Request)

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

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

Deletes project membership in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteProjectMembership operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  member: { /* required */
    groupIdentifier: 'STRING_VALUE',
    userIdentifier: 'STRING_VALUE'
  },
  projectIdentifier: 'STRING_VALUE' /* required */
};
datazone.deleteProjectMembership(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 where project membership is deleted.

    • member — (map)

      The project member whose project membership is deleted.

      • 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 Amazon DataZone project the membership to 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.

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

Deletes and subscription grant in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteSubscriptionGrant operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteSubscriptionGrant(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 where the subscription grant is deleted.

    • identifier — (String)

      The ID of the subscription grant 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:

      • assets — (Array<map>)

        The assets for which the subsctiption grant that is deleted gave access.

        • assetIdrequired — (String)

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

        • assetRevisionrequired — (String)

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

        • assetScope — (map)

          The asset scope of the subscribed asset.

          • assetIdrequired — (String)

            The asset ID of the asset scope.

          • errorMessage — (String)

            The error message of the asset scope.

          • filterIdsrequired — (Array<String>)

            The filter IDs of the asset scope.

          • statusrequired — (String)

            The status of the asset scope.

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

        • statusrequired — (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)

        The timestamp of when the subscription grant that is deleted was created.

      • createdBy — (String)

        The Amazon DataZone user who created the subscription grant that is deleted.

      • domainId — (String)

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

      • grantedEntity — (map)

        The entity to which the subscription is deleted.

        • listing — (map)

          The listing for which a subscription is granted.

          • idrequired — (String)

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

          • revisionrequired — (String)

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

      • id — (String)

        The ID of the subscription grant that is deleted.

      • status — (String)

        The status of the subscription grant that is deleted.

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

        The identifier of the subsctiption whose subscription grant is to be deleted.

      • subscriptionTargetId — (String)

        The ID of the subscription target associated with the subscription grant that is deleted.

      • updatedAt — (Date)

        The timestamp of when the subscription grant that is deleted was updated.

      • updatedBy — (String)

        The Amazon DataZone user who updated the subscription grant that is deleted.

Returns:

  • (AWS.Request)

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

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

Deletes a subscription request in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteSubscriptionRequest operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteSubscriptionRequest(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 subscription request is deleted.

    • identifier — (String)

      The ID of the subscription request 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.

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

Deletes a subscription target in Amazon DataZone.

Service Reference:

Examples:

Calling the deleteSubscriptionTarget operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.deleteSubscriptionTarget(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 subscription target is deleted.

    • environmentIdentifier — (String)

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

    • identifier — (String)

      The ID of the subscription target 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.

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

Deletes the specified time series form for the specified asset.

Service Reference:

Examples:

Calling the deleteTimeSeriesDataPoints operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: ASSET | LISTING, /* required */
  formName: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
datazone.deleteTimeSeriesDataPoints(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 to ensure idempotency of the request. This field is automatically populated if not provided.

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

      The ID of the Amazon DataZone domain that houses the asset for which you want to delete a time series form.

    • entityIdentifier — (String)

      The ID of the asset for which you want to delete a time series form.

    • entityType — (String)

      The type of the asset for which you want to delete a time series form.

      Possible values include:
      • "ASSET"
      • "LISTING"
    • formName — (String)

      The name of the time series form that you want to delete.

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.

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

Disassociates the environment role in Amazon DataZone.

Service Reference:

Examples:

Calling the disassociateEnvironmentRole operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  environmentRoleArn: 'STRING_VALUE' /* required */
};
datazone.disassociateEnvironmentRole(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 an environment role is disassociated.

    • environmentIdentifier — (String)

      The ID of the environment.

    • environmentRoleArn — (String)

      The ARN of the environment role.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Gets an Amazon DataZone asset.

Service Reference:

Examples:

Calling the getAsset operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  revision: 'STRING_VALUE'
};
datazone.getAsset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The ID of the Amazon DataZone domain to which the asset belongs.

    • identifier — (String)

      The ID of the Amazon DataZone asset.

    • revision — (String)

      The revision of the Amazon DataZone 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 was created.

      • createdBy — (String)

        The Amazon DataZone user who created the asset.

      • description — (String)

        The description of the Amazon DataZone asset.

      • domainId — (String)

        The ID of the Amazon DataZone domain to which the asset belongs.

      • externalIdentifier — (String)

        The external ID of the asset.

      • firstRevisionCreatedAt — (Date)

        The timestamp of when the first revision of the asset was created.

      • firstRevisionCreatedBy — (String)

        The Amazon DataZone user who created the first revision of the asset.

      • formsOutput — (Array<map>)

        The metadata forms attached to the asset.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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 business glossary terms attached to the asset.

      • id — (String)

        The ID of the 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.

        • formNamerequired — (String)

          The name of the time series data points summary form.

        • id — (String)

          The ID of the time series data points summary form.

        • timestamprequired — (Date)

          The timestamp of the time series data points summary form.

        • typeIdentifierrequired — (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 listing of the asset.

        • listingIdrequired — (String)

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

        • listingStatusrequired — (String)

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

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

        The name of the asset.

      • owningProjectId — (String)

        The ID of the project that owns the asset.

      • readOnlyFormsOutput — (Array<map>)

        The read-only metadata forms attached to the asset.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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 ID of the asset type.

      • typeRevision — (String)

        The revision of the asset type.

Returns:

  • (AWS.Request)

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

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

Gets an asset filter.

Service Reference:

Examples:

Calling the getAssetFilter operation

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

      The ID of the data asset.

    • domainIdentifier — (String)

      The ID of the domain where you want to get an asset filter.

    • identifier — (String)

      The ID of the asset filter.

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:

      • assetId — (String)

        The ID of the data asset.

      • configuration — (map)

        The configuration of the asset filter.

        • columnConfiguration — (map)

          The column configuration of the asset filter.

          • includedColumnNames — (Array<String>)

            Specifies whether to include column names.

        • rowConfiguration — (map)

          The row configuration of the asset filter.

          • rowFilterrequired — (map)

            The row filter.

            • and — (Array<map>)

              The 'and' clause of the row filter.

            • expression — (map)

              The expression of the row filter.

              • equalTo — (map)

                The 'equal to' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be equal to an expression.

              • greaterThan — (map)

                The 'greater than' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be greater than an expression.

              • greaterThanOrEqualTo — (map)

                The 'greater than or equal to' clause of the filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be greater than or equal to an expression.

              • in — (map)

                The 'in' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuesrequired — (Array<String>)

                  The values that might be in the expression.

              • isNotNull — (map)

                The 'is not null' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

              • isNull — (map)

                The 'is null' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

              • lessThan — (map)

                The 'less than' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be less than the expression.

              • lessThanOrEqualTo — (map)

                The 'less than or equal to' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be less than or equal to an expression.

              • like — (map)

                The 'like' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might be like the expression.

              • notEqualTo — (map)

                The 'no equal to' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might not be equal to the expression.

              • notIn — (map)

                The 'not in' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuesrequired — (Array<String>)

                  The value that might not be in the expression.

              • notLike — (map)

                The 'not like' clause of the row filter expression.

                • columnNamerequired — (String)

                  The name of the column.

                • valuerequired — (String)

                  The value that might not be like the expression.

            • or — (Array<map>)

              The 'or' clause of the row filter.

          • sensitive — (Boolean)

            Specifies whether the row filter is sensitive.

      • createdAt — (Date)

        The timestamp at which the asset filter was created.

      • description — (String)

        The description of the asset filter.

      • domainId — (String)

        The ID of the domain where you want to get an asset filter.

      • effectiveColumnNames — (Array<String>)

        The column names of the asset filter.

      • effectiveRowFilter — (String)

        The row filter of the asset filter.

      • errorMessage — (String)

        The error message that is displayed if the action does not complete successfully.

      • id — (String)

        The ID of the asset filter.

      • name — (String)

        The name of the asset filter.

      • status — (String)

        The status of the asset filter.

        Possible values include:
        • "VALID"
        • "INVALID"

Returns:

  • (AWS.Request)

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

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

Gets an Amazon DataZone asset type.

Service Reference:

Examples:

Calling the getAssetType operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  revision: 'STRING_VALUE'
};
datazone.getAssetType(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 exists.

    • identifier — (String)

      The ID of the asset type.

    • revision — (String)

      The revision of the 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 was created.

      • createdBy — (String)

        The Amazon DataZone user who created the asset type.

      • description — (String)

        The description of the asset type.

      • domainId — (String)

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

      • formsOutput — (map<map>)

        The metadata forms attached to the asset type.

        • required — (Boolean)

          Specifies whether a form entry is required.

        • typeNamerequired — (String)

          The name of the type of the form entry.

        • typeRevisionrequired — (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 in which the asset type was originally created.

      • originProjectId — (String)

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

      • owningProjectId — (String)

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

      • revision — (String)

        The revision of the asset type.

      • updatedAt — (Date)

        The timestamp of when the asset type was updated.

      • updatedBy — (String)

        The Amazon DataZone user that updated the asset type.

Returns:

  • (AWS.Request)

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

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

Gets the data product.

Service Reference:

Examples:

Calling the getDataProduct operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  revision: 'STRING_VALUE'
};
datazone.getDataProduct(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 domain where the data product lives.

    • identifier — (String)

      The ID of the data product.

    • revision — (String)

      The revision of the data product.

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 at which the data product is created.

      • createdBy — (String)

        The user who created the data product.

      • description — (String)

        The description of the data product.

      • domainId — (String)

        The ID of the domain where the data product lives.

      • firstRevisionCreatedAt — (Date)

        The timestamp at which the first revision of the data product is created.

      • firstRevisionCreatedBy — (String)

        The user who created the first revision of the data product.

      • formsOutput — (Array<map>)

        The metadata forms of the data product.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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 of the data product.

      • id — (String)

        The ID of the data product.

      • items — (Array<map>)

        The data assets of the data product.

        • glossaryTerms — (Array<String>)

          The glossary terms of the data product.

        • identifierrequired — (String)

          The ID of the data product.

        • itemTyperequired — (String)

          The type of the data product.

          Possible values include:
          • "ASSET"
        • revision — (String)

          The revision of the data product.

      • name — (String)

        The name of the data product.

      • owningProjectId — (String)

        The ID of the owning project of the data product.

      • revision — (String)

        The revision of the data product.

      • status — (String)

        The status of the data product.

        Possible values include:
        • "CREATED"
        • "CREATING"
        • "CREATE_FAILED"

Returns:

  • (AWS.Request)

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

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

Gets an Amazon DataZone data source.

Service Reference:

Examples:

Calling the getDataSource operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getDataSource(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 data source exists.

    • identifier — (String)

      The ID of the Amazon DataZone 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 created by this data source.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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.

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

          • relationalFilterConfigurationsrequired — (Array<map>)

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

            • databaseNamerequired — (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.

              • expressionrequired — (String)

                The search filter expression.

              • typerequired — (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.

          • redshiftCredentialConfigurationrequired — (map)

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

            • secretManagerArnrequired — (String)

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

          • redshiftStoragerequired — (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.

              • clusterNamerequired — (String)

                The name of an Amazon Redshift cluster.

            • redshiftServerlessSource — (map)

              The details of the Amazon Redshift Serverless workgroup source.

              • workgroupNamerequired — (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.

          • relationalFilterConfigurationsrequired — (Array<map>)

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

            • databaseNamerequired — (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.

              • expressionrequired — (String)

                The search filter expression.

              • typerequired — (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 exists.

      • enableSetting — (String)

        Specifies whether this data source is enabled or not.

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

        The ID of the environment where this data source creates and 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.

        • errorTyperequired — (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.

      • lastRunAssetCount — (Integer)

        The number of assets created by the data source during its last run.

      • lastRunAt — (Date)

        The timestamp of the last run of the data source.

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

        • errorTyperequired — (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 the 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 project where the data source creates and publishes assets.

      • 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)

        The recommendation configuration of the 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"
      • selfGrantStatus — (map)

        Specifies the status of the self-granting functionality.

        • glueSelfGrantStatus — (map)

          The details for the self granting status for a Glue data source.

          • selfGrantStatusDetailsrequired — (Array<map>)

            The details for the self granting status for a Glue data source.

            • databaseNamerequired — (String)

              The name of the database used for the data source.

            • failureCause — (String)

              The reason for why the operation failed.

            • schemaName — (String)

              The name of the schema used in the data source.

            • statusrequired — (String)

              The self granting status of the data source.

              Possible values include:
              • "GRANT_PENDING"
              • "REVOKE_PENDING"
              • "GRANT_IN_PROGRESS"
              • "REVOKE_IN_PROGRESS"
              • "GRANTED"
              • "GRANT_FAILED"
              • "REVOKE_FAILED"
        • redshiftSelfGrantStatus — (map)

          The details for the self granting status for an Amazon Redshift data source.

          • selfGrantStatusDetailsrequired — (Array<map>)

            The details for the self granting status for an Amazon Redshift data source.

            • databaseNamerequired — (String)

              The name of the database used for the data source.

            • failureCause — (String)

              The reason for why the operation failed.

            • schemaName — (String)

              The name of the schema used in the data source.

            • statusrequired — (String)

              The self granting status of the data source.

              Possible values include:
              • "GRANT_PENDING"
              • "REVOKE_PENDING"
              • "GRANT_IN_PROGRESS"
              • "REVOKE_IN_PROGRESS"
              • "GRANTED"
              • "GRANT_FAILED"
              • "REVOKE_FAILED"
      • 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.

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

Gets an Amazon DataZone data source run.

Service Reference:

Examples:

Calling the getDataSourceRun operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getDataSourceRun(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 domain in which this data source run was performed.

    • identifier — (String)

      The ID of the data source 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. The data object has the following properties:

      • createdAt — (Date)

        The timestamp of when the data source run was created.

      • dataSourceConfigurationSnapshot — (String)

        The configuration snapshot of the data source run.

      • dataSourceId — (String)

        The ID of the data source for this data source run.

      • domainId — (String)

        The ID of the domain in which this data source run was performed.

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

        • errorTyperequired — (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 run.

      • projectId — (String)

        The ID of the project in which this data source run occured.

      • runStatisticsForAssets — (map)

        The asset statistics from this data source run.

        • added — (Integer)

          The added statistic for the data source run.

        • failed — (Integer)

          The failed statistic for the data source run.

        • skipped — (Integer)

          The skipped statistic for the data source run.

        • unchanged — (Integer)

          The unchanged statistic for the data source run.

        • updated — (Integer)

          The updated statistic for the data source run.

      • startedAt — (Date)

        The timestamp of when this data source run started.

      • status — (String)

        The status of this data source run.

        Possible values include:
        • "REQUESTED"
        • "RUNNING"
        • "FAILED"
        • "PARTIALLY_SUCCEEDED"
        • "SUCCESS"
      • stoppedAt — (Date)

        The timestamp of when this data source run stopped.

      • type — (String)

        The type of this data source run.

        Possible values include:
        • "PRIORITIZED"
        • "SCHEDULED"
      • updatedAt — (Date)

        The timestamp of when this data source run was updated.

Returns:

  • (AWS.Request)

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

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

Gets an Amazon DataZone domain.

Service Reference:

Examples:

Calling the getDomain operation

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

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

      • createdAt — (Date)

        The timestamp of when the Amazon DataZone domain was created.

      • description — (String)

        The description of the Amazon DataZone domain.

      • domainExecutionRole — (String)

        The domain execution role with which the Amazon DataZone domain is created.

      • id — (String)

        The identifier of the specified 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.

      • lastUpdatedAt — (Date)

        The timestamp of when the Amazon DataZone domain was last updated.

      • name — (String)

        The name of the Amazon DataZone domain.

      • portalUrl — (String)

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

      • rootDomainUnitId — (String)

        The ID of the root domain in Amazon Datazone.

      • singleSignOn — (map)

        The single sing-on option of the specified 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 specified 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.

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

Gets the details of the specified domain unit.

Service Reference:

Examples:

Calling the getDomainUnit operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getDomainUnit(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 domain where you want to get a domain unit.

    • identifier — (String)

      The identifier of the domain unit that you want to get.

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 time stamp at which the domain unit was created.

      • createdBy — (String)

        The user who created the domain unit.

      • description — (String)

        The description of the domain unit.

      • domainId — (String)

        The ID of the domain in which the domain unit lives.

      • id — (String)

        The ID of the domain unit.

      • lastUpdatedAt — (Date)

        The timestamp at which the domain unit was last updated.

      • lastUpdatedBy — (String)

        The user who last updated the domain unit.

      • name — (String)

        The name of the domain unit.

      • owners — (Array<map>)

        The owners of the domain unit.

        • group — (map)

          Indicates that the domain unit owner is a group.

          • groupId — (String)

            The ID of the domain unit group.

        • user — (map)

          Indicates that the domain unit owner is a user.

          • userId — (String)

            The ID of teh domain unit user.

      • parentDomainUnitId — (String)

        The ID of the parent domain unit.

Returns:

  • (AWS.Request)

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

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

Gets an Amazon DataZone environment.

Service Reference:

Examples:

Calling the getEnvironment operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getEnvironment(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 where the environment exists.

    • identifier — (String)

      The ID of the Amazon DataZone environment.

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 ID of the Amazon Web Services account where the environment exists.

      • awsAccountRegion — (String)

        The Amazon Web Services region where the environment exists.

      • createdAt — (Date)

        The timestamp of when the environment was created.

      • createdBy — (String)

        The Amazon DataZone user who created the environment.

      • deploymentProperties — (map)

        The deployment properties of the 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 the environment.

      • domainId — (String)

        The ID of the Amazon DataZone domain where the environment exists.

      • environmentActions — (Array<map>)

        The actions of the environment.

        • auth — (String)

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

          Possible values include:
          • "IAM"
          • "HTTPS"
        • parametersrequired — (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.

        • typerequired — (String)

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

      • environmentBlueprintId — (String)

        The blueprint with which the environment is created.

      • environmentProfileId — (String)

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

      • glossaryTerms — (Array<String>)

        The business glossary terms that can be used in this environment.

      • id — (String)

        The ID of the environment.

      • lastDeployment — (map)

        The details of the last deployment of the 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.

          • messagerequired — (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 the 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.

        • typerequired — (String)

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

        • valuerequired — (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.

          • templateUrlrequired — (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.

        • fieldTyperequired — (String)

          The filed type of the parameter.

        • isEditable — (Boolean)

          Specifies whether the parameter is editable.

        • isOptional — (Boolean)

          Specifies whether the custom parameter is optional.

        • keyNamerequired — (String)

          The key name of the parameter.

Returns:

  • (AWS.Request)

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

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

Gets the specified environment action.

Service Reference:

Examples:

Calling the getEnvironmentAction operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getEnvironmentAction(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 GetEnvironmentAction API is invoked.

    • environmentIdentifier — (String)

      The environment ID of the environment action.

    • identifier — (String)

      The ID of the environment action

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 the environment action.

      • domainId — (String)

        The ID of the Amazon DataZone domain in which the environment action lives.

      • environmentId — (String)

        The environment ID of the environment action.

      • id — (String)

        The ID of the environment action.

      • name — (String)

        The name of the environment action.

      • parameters — (map)

        The parameters of the environment action.

        • awsConsoleLink — (map)

          The console link specified as part of the environment action.

          • uri — (String)

            The URI of the console link specified as part of the environment action.

Returns:

  • (AWS.Request)

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

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

Gets an Amazon DataZone blueprint.

Service Reference:

Examples:

Calling the getEnvironmentBlueprint operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getEnvironmentBlueprint(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 identifier of the domain in which this blueprint exists.

    • identifier — (String)

      The ID of this Amazon DataZone blueprint.

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 this blueprint was created.

      • deploymentProperties — (map)

        The deployment properties of this Amazon DataZone blueprint.

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

      • glossaryTerms — (Array<String>)

        The glossary terms attached to this Amazon DataZone blueprint.

      • id — (String)

        The ID of this Amazon DataZone blueprint.

      • name — (String)

        The name of this Amazon DataZone blueprint.

      • provider — (String)

        The provider of this Amazon DataZone blueprint.

      • provisioningProperties — (map)

        The provisioning properties of this Amazon DataZone blueprint.

        • cloudFormation — (map)

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

          • templateUrlrequired — (String)

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

      • updatedAt — (Date)

        The timestamp of when this blueprint was updated.

      • userParameters — (Array<map>)

        The user parameters of this blueprint.

        • defaultValue — (String)

          The default value of the parameter.

        • description — (String)

          The description of the parameter.

        • fieldTyperequired — (String)

          The filed type of the parameter.

        • isEditable — (Boolean)

          Specifies whether the parameter is editable.

        • isOptional — (Boolean)

          Specifies whether the custom parameter is optional.

        • keyNamerequired — (String)

          The key name of the parameter.

Returns:

  • (AWS.Request)

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

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

Gets the blueprint configuration in Amazon DataZone.

Examples:

Calling the getEnvironmentBlueprintConfiguration operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentBlueprintIdentifier: 'STRING_VALUE' /* required */
};
datazone.getEnvironmentBlueprintConfiguration(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 where this blueprint exists.

    • environmentBlueprintIdentifier — (String)

      He ID of the blueprint.

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 this blueprint was created.

      • domainId — (String)

        The ID of the Amazon DataZone domain where this blueprint exists.

      • enabledRegions — (Array<String>)

        The Amazon Web Services regions in which this blueprint is enabled.

      • environmentBlueprintId — (String)

        The ID of the blueprint.

      • manageAccessRoleArn — (String)

        The ARN of the manage access role with which this blueprint is created.

      • provisioningConfigurations — (Array<map>)

        The provisioning configuration of a blueprint.

        • lakeFormationConfiguration — (map)

          The Lake Formation configuration of the Data Lake blueprint.

          • locationRegistrationExcludeS3Locations — (Array<String>)

            Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

          • locationRegistrationRole — (String)

            The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.

      • provisioningRoleArn — (String)

        The ARN of the provisioning role with which this blueprint is created.

      • regionalParameters — (map<map<String>>)

        The regional parameters of the blueprint.

      • updatedAt — (Date)

        The timestamp of when this blueprint was upated.

Returns:

  • (AWS.Request)

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

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

Gets the credentials of an environment in Amazon DataZone.

Service Reference:

Examples:

Calling the getEnvironmentCredentials operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE' /* required */
};
datazone.getEnvironmentCredentials(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 this environment and its credentials exist.

    • environmentIdentifier — (String)

      The ID of the environment whose credentials this operation gets.

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:

      • accessKeyId — (String)

        The access key ID of the environment.

      • expiration — (Date)

        The expiration timestamp of the environment credentials.

      • secretAccessKey — (String)

        The secret access key of the environment credentials.

      • sessionToken — (String)

        The session token of the environment credentials.

Returns:

  • (AWS.Request)

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

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

Gets an evinronment profile in Amazon DataZone.

Service Reference:

Examples:

Calling the getEnvironmentProfile operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getEnvironmentProfile(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 this environment profile exists.

    • identifier — (String)

      The ID of the environment profile.

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 ID of the Amazon Web Services account where this environment profile exists.

      • awsAccountRegion — (String)

        The Amazon Web Services region where this environment profile exists.

      • 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 the environment profile.

      • domainId — (String)

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

      • environmentBlueprintId — (String)

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

      • id — (String)

        The ID of the environment profile.

      • name — (String)

        The name of the 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 upated.

      • userParameters — (Array<map>)

        The user parameters of the environment profile.

        • defaultValue — (String)

          The default value of the parameter.

        • description — (String)

          The description of the parameter.

        • fieldTyperequired — (String)

          The filed type of the parameter.

        • isEditable — (Boolean)

          Specifies whether the parameter is editable.

        • isOptional — (Boolean)

          Specifies whether the custom parameter is optional.

        • keyNamerequired — (String)

          The key name of the parameter.

Returns:

  • (AWS.Request)

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

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

Gets a metadata form type in Amazon DataZone.

Service Reference:

Examples:

Calling the getFormType operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  formTypeIdentifier: 'STRING_VALUE', /* required */
  revision: 'STRING_VALUE'
};
datazone.getFormType(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 this metadata form type exists.

    • formTypeIdentifier — (String)

      The ID of the metadata form type.

    • revision — (String)

      The revision of this metadata form 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 this metadata form type was created.

      • createdBy — (String)

        The Amazon DataZone user who created this metadata form type.

      • description — (String)

        The description of the metadata form type.

      • domainId — (String)

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

      • imports — (Array<map>)

        The imports of the metadata form type.

        • namerequired — (String)

          The name of the import.

        • revisionrequired — (String)

          The revision of the import.

      • model — (map)

        The model of the metadata form type.

        • smithy — (String)

          Indicates the smithy model of the API.

      • name — (String)

        The name of the metadata form type.

      • originDomainId — (String)

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

      • originProjectId — (String)

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

      • owningProjectId — (String)

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

      • revision — (String)

        The revision of the metadata form type.

      • status — (String)

        The status of the metadata form type.

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

Returns:

  • (AWS.Request)

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

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

Gets a business glossary in Amazon DataZone.

Service Reference:

Examples:

Calling the getGlossary operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getGlossary(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 this business glossary exists.

    • identifier — (String)

      The ID of the business glossary.

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 this business glossary was created.

      • createdBy — (String)

        The Amazon DataZone user who created this business glossary.

      • description — (String)

        The description of the business glossary.

      • domainId — (String)

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

      • id — (String)

        The ID of the business glossary.

      • name — (String)

        The name of the business glossary.

      • owningProjectId — (String)

        The ID of the project that owns this business glossary.

      • status — (String)

        The status of the business glossary.

        Possible values include:
        • "DISABLED"
        • "ENABLED"
      • updatedAt — (Date)

        The timestamp of when the business glossary was updated.

      • updatedBy — (String)

        The Amazon DataZone user who updated the business glossary.

Returns:

  • (AWS.Request)

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

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

Gets a business glossary term in Amazon DataZone.

Service Reference:

Examples:

Calling the getGlossaryTerm operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getGlossaryTerm(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 this business glossary term exists.

    • identifier — (String)

      The ID of the business glossary term.

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 business glossary term was created.

      • createdBy — (String)

        The Amazon DataZone user who created the business glossary.

      • domainId — (String)

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

      • glossaryId — (String)

        The ID of the business glossary to which this term belongs.

      • id — (String)

        The ID of the business glossary term.

      • longDescription — (String)

        The long description of the business glossary term.

      • name — (String)

        The name of the business glossary term.

      • shortDescription — (String)

        The short decription of the business glossary term.

      • status — (String)

        The status of the business glossary term.

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

        The relations of the business glossary term.

        • classifies — (Array<String>)

          The classifies of the term relations.

        • isA — (Array<String>)

          The isA property of the term relations.

      • updatedAt — (Date)

        The timestamp of when the business glossary term was updated.

      • updatedBy — (String)

        The Amazon DataZone user who updated the business glossary term.

Returns:

  • (AWS.Request)

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

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

Gets a group profile in Amazon DataZone.

Service Reference:

Examples:

Calling the getGroupProfile operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  groupIdentifier: 'STRING_VALUE' /* required */
};
datazone.getGroupProfile(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 identifier of the Amazon DataZone domain in which the group profile exists.

    • groupIdentifier — (String)

      The identifier of the group profile.

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

      • groupName — (String)

        The name of the group for which the specified group profile exists.

      • id — (String)

        The identifier of the group profile.

      • status — (String)

        The identifier of the group profile.

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

Returns:

  • (AWS.Request)

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

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

Gets the data portal URL for the specified Amazon DataZone domain.

Service Reference:

Examples:

Calling the getIamPortalLoginUrl operation

var params = {
  domainIdentifier: 'STRING_VALUE' /* required */
};
datazone.getIamPortalLoginUrl(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 the data portal of which you want to get.

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:

      • authCodeUrl — (String)

        The data portal URL of the specified Amazon DataZone domain.

      • userProfileId — (String)

        The ID of the user profile.

Returns:

  • (AWS.Request)

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

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

Gets the data lineage node.

Service Reference:

Examples:

Calling the getLineageNode operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  eventTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
datazone.getLineageNode(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 domain in which you want to get the data lineage node.

    • eventTimestamp — (Date)

      The event time stamp for which you want to get the data lineage node.

    • identifier — (String)

      The ID of the data lineage node that you want to get.

      Both, a lineage node identifier generated by Amazon DataZone and a sourceIdentifier of the lineage node are supported. If sourceIdentifier is greater than 1800 characters, you can use lineage node identifier generated by Amazon DataZone to get the node details.

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 at which the data lineage node was created.

      • createdBy — (String)

        The user who created the data lineage node.

      • description — (String)

        The description of the data lineage node.

      • domainId — (String)

        The ID of the domain where you're getting the data lineage node.

      • downstreamNodes — (Array<map>)

        The downsteam nodes of the specified data lineage node.

        • eventTimestamp — (Date)

          The event timestamp of the data lineage node.

        • id — (String)

          The ID of the data lineage node.

      • eventTimestamp — (Date)

        The timestamp of the event described in the data lineage node.

      • formsOutput — (Array<map>)

        The metadata of the specified data lineage node.

        • content — (String)

          The content of the metadata form.

        • formNamerequired — (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.

      • id — (String)

        The ID of the data lineage node.

      • name — (String)

        The name of the data lineage node.

      • sourceIdentifier — (String)

        The source identifier of the data lineage node.

      • typeName — (String)

        The name of the type of the specified data lineage node.

      • typeRevision — (String)

        The revision type of the specified data lineage node.

      • updatedAt — (Date)

        The timestamp at which the data lineage node was updated.

      • updatedBy — (String)

        The user who updated the data lineage node.

      • upstreamNodes — (Array<map>)

        The upstream nodes of the specified data lineage node.

        • eventTimestamp — (Date)

          The event timestamp of the data lineage node.

        • id — (String)

          The ID of the data lineage node.

Returns:

  • (AWS.Request)

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

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

Gets a listing (a record of an asset at a given time). If you specify a listing version, only details that are specific to that version are returned.

Service Reference:

Examples:

Calling the getListing operation

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

    • listingRevision — (String)

      The revision of the listing.

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 listing was created.

      • createdBy — (String)

        The Amazon DataZone user who created the listing.

      • description — (String)

        The description of the listing.

      • domainId — (String)

        The ID of the Amazon DataZone domain.

      • id — (String)

        The ID of the listing.

      • item — (map)

        The details of a listing.

        • assetListing — (map)

          An asset published in an Amazon DataZone catalog.

          • assetId — (String)

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

          • assetRevision — (String)

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

          • assetType — (String)

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

          • createdAt — (Date)

            The timestamp of when an asset published in an Amazon DataZone catalog was created.

          • forms — (String)

            The metadata forms attached to an asset published in an Amazon DataZone catalog.

          • glossaryTerms — (Array<map>)

            The glossary terms attached to an asset published in an Amazon DataZone catalog.

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

          • latestTimeSeriesDataPointForms — (Array<map>)

            The latest time series data points forms included in the additional attributes of an asset.

            • contentSummary — (String)

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

            • formNamerequired — (String)

              The name of the time series data points summary form.

            • id — (String)

              The ID of the time series data points summary form.

            • timestamprequired — (Date)

              The timestamp of the time series data points summary form.

            • typeIdentifierrequired — (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.

          • owningProjectId — (String)

            The identifier of the project where an asset published in an Amazon DataZone catalog exists.

        • dataProductListing — (map)

          The data product listing.

          • createdAt — (Date)

            The timestamp at which the data product listing was created.

          • dataProductId — (String)

            The ID of the data product listing.

          • dataProductRevision — (String)

            The revision of the data product listing.

          • forms — (String)

            The metadata forms of the data product listing.

          • glossaryTerms — (Array<map>)

            The glossary terms of the data product listing.

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

          • items — (Array<map>)

            The data assets of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product.

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

            • listingId — (String)

              The ID of the data product listing.

            • listingRevision — (String)

              The revision of the data product listing.

          • owningProjectId — (String)

            The ID of the owning project of the data product listing.

      • listingRevision — (String)

        The revision of a listing.

      • name — (String)

        The name of the listing.

      • status — (String)

        The status of the listing.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "INACTIVE"
      • updatedAt — (Date)

        The timestamp of when the listing was updated.

      • updatedBy — (String)

        The Amazon DataZone user who updated the listing.

Returns:

  • (AWS.Request)

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

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

Gets a metadata generation run in Amazon DataZone.

Service Reference:

Examples:

Calling the getMetadataGenerationRun operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getMetadataGenerationRun(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 the metadata generation run of which you want to get.

    • identifier — (String)

      The identifier 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. The data object has the following properties:

      • createdAt — (Date)

        The timestamp of when the metadata generation run was start.

      • createdBy — (String)

        The Amazon DataZone user who started the metadata generation run.

      • domainId — (String)

        The ID of the Amazon DataZone domain the metadata generation run of which you want to get.

      • id — (String)

        The ID of the metadata generation run.

      • owningProjectId — (String)

        The ID of the project that owns the assets for which you're running metadata generation.

      • status — (String)

        The status of the metadata generation run.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "CANCELED"
        • "SUCCEEDED"
        • "FAILED"
      • target — (map)

        The asset for which you're generating metadata.

        • identifierrequired — (String)

          The ID of the metadata generation run's target.

        • revision — (String)

          The revision of the asset for which metadata was generated.

        • typerequired — (String)

          The type of the asset for which metadata was generated.

          Possible values include:
          • "ASSET"
      • type — (String)

        The type of metadata generation run.

        Possible values include:
        • "BUSINESS_DESCRIPTIONS"

Returns:

  • (AWS.Request)

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

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

Gets a project in Amazon DataZone.

Service Reference:

Examples:

Calling the getProject operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getProject(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 project exists.

    • identifier — (String)

      The ID of the 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 ID of the Amazon DataZone domain in which the project exists.

      • domainUnitId — (String)

        The ID of the domain unit.

      • 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 business glossary terms that can be used in the project.

      • id — (String)

        >The ID of the 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 project.

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

Returns:

  • (AWS.Request)

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

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

Gets a subscription in Amazon DataZone.

Service Reference:

Examples:

Calling the getSubscription operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getSubscription(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 subscription exists.

    • identifier — (String)

      The ID of the subscription.

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 subscription was created.

      • createdBy — (String)

        The Amazon DataZone user who created the subscription.

      • domainId — (String)

        The ID of the Amazon DataZone domain in which the subscription exists.

      • id — (String)

        The ID of the subscription.

      • retainPermissions — (Boolean)

        The retain permissions of the subscription.

      • status — (String)

        The status of the subscription.

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

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

        • descriptionrequired — (String)

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

        • idrequired — (String)

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

        • itemrequired — (map)

          The published asset for which the subscription grant is created.

          • assetListing — (map)

            The asset for which the subscription grant is created.

            • assetScope — (map)

              The asset scope of the subscribed asset listing.

              • assetIdrequired — (String)

                The asset ID of the asset scope.

              • errorMessage — (String)

                The error message of the asset scope.

              • filterIdsrequired — (Array<String>)

                The filter IDs of the asset scope.

              • statusrequired — (String)

                The status of the asset scope.

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

          • productListing — (map)

            The data product listing.

            • assetListings — (Array<map>)

              The data assets of the data product listing.

              • entityId — (String)

                The entity ID of the listing of the asset in a data product.

              • entityRevision — (String)

                The entity revision of the listing of the asset in a data product.

              • entityType — (String)

                The entity type of the listing of the asset in a data product.

            • description — (String)

              The description of the data product listing.

            • entityId — (String)

              The ID of the data product listing.

            • entityRevision — (String)

              The revision of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product listing.

              • 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 — (String)

              The name of the data product listing.

        • namerequired — (String)

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

        • ownerProjectIdrequired — (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 principal that owns the subscription.

        • 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 ID of the subscription request.

      • updatedAt — (Date)

        The timestamp of when the subscription was updated.

      • updatedBy — (String)

        The Amazon DataZone user who updated the subscription.

Returns:

  • (AWS.Request)

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

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

Gets the subscription grant in Amazon DataZone.

Service Reference:

Examples:

Calling the getSubscriptionGrant operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getSubscriptionGrant(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 subscription grant exists.

    • identifier — (String)

      The ID of the 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:

      • assets — (Array<map>)

        The assets for which the subscription grant is created.

        • assetIdrequired — (String)

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

        • assetRevisionrequired — (String)

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

        • assetScope — (map)

          The asset scope of the subscribed asset.

          • assetIdrequired — (String)

            The asset ID of the asset scope.

          • errorMessage — (String)

            The error message of the asset scope.

          • filterIdsrequired — (Array<String>)

            The filter IDs of the asset scope.

          • statusrequired — (String)

            The status of the asset scope.

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

        • statusrequired — (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)

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

      • grantedEntity — (map)

        The entity to which the subscription is granted.

        • listing — (map)

          The listing for which a subscription is granted.

          • idrequired — (String)

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

          • revisionrequired — (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.

      • subscriptionTargetId — (String)

        The subscription target ID associated with the subscription grant.

      • updatedAt — (Date)

        The timestamp of when the subscription grant was upated.

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

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

Gets the details of the specified subscription request.

Service Reference:

Examples:

Calling the getSubscriptionRequestDetails operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getSubscriptionRequestDetails(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 identifier of the Amazon DataZone domain in which to get the subscription request details.

    • identifier — (String)

      The identifier of the subscription request the details of which to get.

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 specified subscription request was created.

      • createdBy — (String)

        The Amazon DataZone user who created the subscription request.

      • decisionComment — (String)

        The decision comment of the subscription request.

      • domainId — (String)

        The Amazon DataZone domain of the subscription request.

      • id — (String)

        The identifier of the subscription request.

      • requestReason — (String)

        The reason for the subscription request.

      • reviewerId — (String)

        The identifier of the Amazon DataZone user who reviewed the subscription request.

      • status — (String)

        The status of the subscription request.

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

        The subscribed listings in the subscription request.

        • descriptionrequired — (String)

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

        • idrequired — (String)

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

        • itemrequired — (map)

          The published asset for which the subscription grant is created.

          • assetListing — (map)

            The asset for which the subscription grant is created.

            • assetScope — (map)

              The asset scope of the subscribed asset listing.

              • assetIdrequired — (String)

                The asset ID of the asset scope.

              • errorMessage — (String)

                The error message of the asset scope.

              • filterIdsrequired — (Array<String>)

                The filter IDs of the asset scope.

              • statusrequired — (String)

                The status of the asset scope.

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

          • productListing — (map)

            The data product listing.

            • assetListings — (Array<map>)

              The data assets of the data product listing.

              • entityId — (String)

                The entity ID of the listing of the asset in a data product.

              • entityRevision — (String)

                The entity revision of the listing of the asset in a data product.

              • entityType — (String)

                The entity type of the listing of the asset in a data product.

            • description — (String)

              The description of the data product listing.

            • entityId — (String)

              The ID of the data product listing.

            • entityRevision — (String)

              The revision of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product listing.

              • 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 — (String)

              The name of the data product listing.

        • namerequired — (String)

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

        • ownerProjectIdrequired — (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 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)

        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.

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

Gets the subscription target in Amazon DataZone.

Service Reference:

Examples:

Calling the getSubscriptionTarget operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getSubscriptionTarget(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 subscription target exists.

    • environmentIdentifier — (String)

      The ID of the environment associated with the subscription target.

    • identifier — (String)

      The ID 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 associated with the subscription target.

      • authorizedPrincipals — (Array<String>)

        The authorized 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 exists.

      • environmentId — (String)

        The ID of the environment associated with the subscription target.

      • 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)

        The ID of the project associated with the subscription target.

      • provider — (String)

        The provider of the subscription target.

      • subscriptionTargetConfig — (Array<map>)

        The configuration of teh subscription target.

        • contentrequired — (String)

          The content of the subscription target configuration.

        • formNamerequired — (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.

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

Gets the existing data point for the asset.

Service Reference:

Examples:

Calling the getTimeSeriesDataPoint operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: ASSET | LISTING, /* required */
  formName: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE' /* required */
};
datazone.getTimeSeriesDataPoint(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 that houses the asset for which you want to get the data point.

    • entityIdentifier — (String)

      The ID of the asset for which you want to get the data point.

    • entityType — (String)

      The type of the asset for which you want to get the data point.

      Possible values include:
      • "ASSET"
      • "LISTING"
    • formName — (String)

      The name of the time series form that houses the data point that you want to get.

    • identifier — (String)

      The ID of the data point that you want to get.

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 that houses the asset data point that you want to get.

      • entityId — (String)

        The ID of the asset for which you want to get the data point.

      • entityType — (String)

        The type of the asset for which you want to get the data point.

        Possible values include:
        • "ASSET"
        • "LISTING"
      • form — (map)

        The time series form that houses the data point that you want to get.

        • content — (String)

          The content of the time series data points form.

        • formNamerequired — (String)

          The name of the time series data points form.

        • id — (String)

          The ID of the time series data points form.

        • timestamprequired — (Date)

          The timestamp of the time series data points form.

        • typeIdentifierrequired — (String)

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

        • typeRevision — (String)

          The revision type of the time series data points form.

      • formName — (String)

        The name of the time series form that houses the data point that you want to get.

Returns:

  • (AWS.Request)

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

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

Gets a user profile in Amazon DataZone.

Service Reference:

Examples:

Calling the getUserProfile operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  userIdentifier: 'STRING_VALUE', /* required */
  type: IAM | SSO
};
datazone.getUserProfile(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 the data portal of which you want to get.

    • type — (String)

      The type of the user profile.

      Possible values include:
      • "IAM"
      • "SSO"
    • userIdentifier — (String)

      The identifier of the user for which you want to get the user profile.

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 of which you want to get the user profile.

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

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

Lists asset filters.

Service Reference:

Examples:

Calling the listAssetFilters operation

var params = {
  assetIdentifier: 'STRING_VALUE', /* required */
  domainIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: VALID | INVALID
};
datazone.listAssetFilters(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: {})
    • assetIdentifier — (String)

      The ID of the data asset.

    • domainIdentifier — (String)

      The ID of the domain where you want to list asset filters.

    • maxResults — (Integer)

      The maximum number of asset filters to return in a single call to ListAssetFilters. When the number of asset filters to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAssetFilters to list the next set of asset filters.

    • nextToken — (String)

      When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

    • status — (String)

      The status of the asset filter.

      Possible values include:
      • "VALID"
      • "INVALID"

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:

      • items — (Array<map>)

        The results of the ListAssetFilters action.

        • assetIdrequired — (String)

          The ID of the data asset.

        • createdAt — (Date)

          The timestamp at which the asset filter was created.

        • description — (String)

          The description of the asset filter.

        • domainIdrequired — (String)

          The ID of the domain where the asset filter lives.

        • effectiveColumnNames — (Array<String>)

          The effective column names of the asset filter.

        • effectiveRowFilter — (String)

          The effective row filter of the asset filter.

        • errorMessage — (String)

          The error message that is displayed if the action does not succeed.

        • idrequired — (String)

          The ID of the asset filter.

        • namerequired — (String)

          The name of the asset filter.

        • status — (String)

          The status of the asset filter.

          Possible values include:
          • "VALID"
          • "INVALID"
      • nextToken — (String)

        When the number of asset filters is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of asset filters, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetFilters to list the next set of asset filters.

Returns:

  • (AWS.Request)

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

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

Lists the revisions for the asset.

Service Reference:

Examples:

Calling the listAssetRevisions operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listAssetRevisions(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 identifier of the domain.

    • identifier — (String)

      The identifier of the asset.

    • maxResults — (Integer)

      The maximum number of revisions to return in a single call to ListAssetRevisions. When the number of revisions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListAssetRevisions to list the next set of revisions.

    • nextToken — (String)

      When the number of revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetRevisions to list the next set of revisions.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • items — (Array<map>)

        The results of the ListAssetRevisions action.

        • createdAt — (Date)

          The timestamp of when an inventory asset revison was created.

        • createdBy — (String)

          The Amazon DataZone user who created the asset revision.

        • domainId — (String)

          The Amazon DataZone user who created the inventory asset.

        • id — (String)

          The identifier of the inventory asset revision.

        • revision — (String)

          The revision details of the inventory asset.

      • nextToken — (String)

        When the number of revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListAssetRevisions to list the next set of revisions.

Returns:

  • (AWS.Request)

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

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

Lists data product revisions.

Service Reference:

Examples:

Calling the listDataProductRevisions operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listDataProductRevisions(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 domain of the data product revisions that you want to list.

    • identifier — (String)

      The ID of the data product revision.

    • maxResults — (Integer)

      The maximum number of asset filters to return in a single call to ListDataProductRevisions. When the number of data product revisions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

    • nextToken — (String)

      When the number of data product revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data product revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • items — (Array<map>)

        The results of the ListDataProductRevisions action.

        • createdAt — (Date)

          The timestamp at which the data product revision was created.

        • createdBy — (String)

          The user who created the data product revision.

        • domainId — (String)

          The ID of the domain where the data product revision lives.

        • id — (String)

          The ID of the data product revision.

        • revision — (String)

          The data product revision.

      • nextToken — (String)

        When the number of data product revisions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data product revisions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataProductRevisions to list the next set of data product revisions.

Returns:

  • (AWS.Request)

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

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

Lists data source run activities.

Service Reference:

Examples:

Calling the listDataSourceRunActivities operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: FAILED | PUBLISHING_FAILED | SUCCEEDED_CREATED | SUCCEEDED_UPDATED | SKIPPED_ALREADY_IMPORTED | SKIPPED_ARCHIVED | SKIPPED_NO_ACCESS | UNCHANGED
};
datazone.listDataSourceRunActivities(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 identifier of the Amazon DataZone domain in which to list data source run activities.

    • identifier — (String)

      The identifier of the data source run.

    • maxResults — (Integer)

      The maximum number of activities to return in a single call to ListDataSourceRunActivities. When the number of activities to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSourceRunActivities to list the next set of activities.

    • nextToken — (String)

      When the number of activities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of activities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRunActivities to list the next set of activities.

    • status — (String)

      The status of the data source run.

      Possible values include:
      • "FAILED"
      • "PUBLISHING_FAILED"
      • "SUCCEEDED_CREATED"
      • "SUCCEEDED_UPDATED"
      • "SKIPPED_ALREADY_IMPORTED"
      • "SKIPPED_ARCHIVED"
      • "SKIPPED_NO_ACCESS"
      • "UNCHANGED"

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:

      • items — (Array<map>)

        The results of the ListDataSourceRunActivities action.

        • createdAtrequired — (Date)

          The timestamp of when data source run activity was created.

        • dataAssetId — (String)

          The identifier of the asset included in the data source run activity.

        • dataAssetStatusrequired — (String)

          The status of the asset included in the data source run activity.

          Possible values include:
          • "FAILED"
          • "PUBLISHING_FAILED"
          • "SUCCEEDED_CREATED"
          • "SUCCEEDED_UPDATED"
          • "SKIPPED_ALREADY_IMPORTED"
          • "SKIPPED_ARCHIVED"
          • "SKIPPED_NO_ACCESS"
          • "UNCHANGED"
        • dataSourceRunIdrequired — (String)

          The identifier of the data source for the data source run activity.

        • databaserequired — (String)

          The database included in the data source run activity.

        • errorMessage — (map)

          The details of 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.

          • errorTyperequired — (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"
        • projectIdrequired — (String)

          The project ID included in the data source run activity.

        • technicalDescription — (String)

          The technical description included in the data source run activity.

        • technicalNamerequired — (String)

          The technical name included in the data source run activity.

        • updatedAtrequired — (Date)

          The timestamp of when data source run activity was updated.

      • nextToken — (String)

        When the number of activities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of activities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRunActivities to list the next set of activities.

Returns:

  • (AWS.Request)

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

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

Lists data source runs in Amazon DataZone.

Service Reference:

Examples:

Calling the listDataSourceRuns operation

var params = {
  dataSourceIdentifier: 'STRING_VALUE', /* required */
  domainIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: REQUESTED | RUNNING | FAILED | PARTIALLY_SUCCEEDED | SUCCESS
};
datazone.listDataSourceRuns(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: {})
    • dataSourceIdentifier — (String)

      The identifier of the data source.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain in which to invoke the ListDataSourceRuns action.

    • maxResults — (Integer)

      The maximum number of runs to return in a single call to ListDataSourceRuns. When the number of runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSourceRuns to list the next set of runs.

    • nextToken — (String)

      When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

    • status — (String)

      The status of the data source.

      Possible values include:
      • "REQUESTED"
      • "RUNNING"
      • "FAILED"
      • "PARTIALLY_SUCCEEDED"
      • "SUCCESS"

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:

      • items — (Array<map>)

        The results of the ListDataSourceRuns action.

        • createdAtrequired — (Date)

          The timestamp of when a data source run was created.

        • dataSourceIdrequired — (String)

          The identifier of the data source of the data source run.

        • errorMessage — (map)

          The details of 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.

          • errorTyperequired — (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"
        • idrequired — (String)

          The identifier of the data source run.

        • projectIdrequired — (String)

          The project ID of the data source run.

        • runStatisticsForAssets — (map)

          The asset statistics from the data source run.

          • added — (Integer)

            The added statistic for the data source run.

          • failed — (Integer)

            The failed statistic for the data source run.

          • skipped — (Integer)

            The skipped statistic for the data source run.

          • unchanged — (Integer)

            The unchanged statistic for the data source run.

          • updated — (Integer)

            The updated statistic for the data source run.

        • startedAt — (Date)

          The timestamp of when a data source run was started.

        • statusrequired — (String)

          The status of the data source run.

          Possible values include:
          • "REQUESTED"
          • "RUNNING"
          • "FAILED"
          • "PARTIALLY_SUCCEEDED"
          • "SUCCESS"
        • stoppedAt — (Date)

          The timestamp of when a data source run was stopped.

        • typerequired — (String)

          The type of the data source run.

          Possible values include:
          • "PRIORITIZED"
          • "SCHEDULED"
        • updatedAtrequired — (Date)

          The timestamp of when a data source run was updated.

      • nextToken — (String)

        When the number of runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSourceRuns to list the next set of runs.

Returns:

  • (AWS.Request)

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

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

Lists data sources in Amazon DataZone.

Service Reference:

Examples:

Calling the listDataSources operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  projectIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  status: CREATING | FAILED_CREATION | READY | UPDATING | FAILED_UPDATE | RUNNING | DELETING | FAILED_DELETION,
  type: 'STRING_VALUE'
};
datazone.listDataSources(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 identifier of the Amazon DataZone domain in which to list the data sources.

    • environmentIdentifier — (String)

      The identifier of the environment in which to list the data sources.

    • maxResults — (Integer)

      The maximum number of data sources to return in a single call to ListDataSources. When the number of data sources to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDataSources to list the next set of data sources.

    • name — (String)

      The name of the data source.

    • nextToken — (String)

      When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

    • projectIdentifier — (String)

      The identifier of the project in which to list data sources.

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

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:

      • items — (Array<map>)

        The results of the ListDataSources action.

        • createdAt — (Date)

          The timestamp of when the data source was created.

        • dataSourceIdrequired — (String)

          The ID of the data source.

        • domainIdrequired — (String)

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

        • enableSetting — (String)

          Specifies whether the data source is enabled.

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

          The ID of the environment in which the data source exists.

        • lastRunAssetCount — (Integer)

          The count of the assets created during the last data source run.

        • lastRunAt — (Date)

          The timestamp of when the data source run was last performed.

        • lastRunErrorMessage — (map)

          The details of 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.

          • errorTyperequired — (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 data source run.

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

          The name of the data source.

        • schedule — (map)

          The details of 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"
        • statusrequired — (String)

          The status of the data source.

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

          The type of the data source.

        • updatedAt — (Date)

          The timestamp of when the data source was updated.

      • nextToken — (String)

        When the number of data sources is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data sources, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDataSources to list the next set of data sources.

Returns:

  • (AWS.Request)

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

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

Lists Amazon DataZone domains.

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: CREATING | AVAILABLE | CREATION_FAILED | DELETING | DELETED | DELETION_FAILED
};
datazone.listDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The maximum number of domains to return in a single call to ListDomains. When the number of domains to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomains to list the next set of domains.

    • nextToken — (String)

      When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

    • status — (String)

      The status of the data source.

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

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:

      • items — (Array<map>)

        The results of the ListDomains action.

        • arnrequired — (String)

          The ARN of the Amazon DataZone domain.

        • createdAtrequired — (Date)

          A timestamp of when a Amazon DataZone domain was created.

        • description — (String)

          A description of an Amazon DataZone domain.

        • idrequired — (String)

          The ID of the Amazon DataZone domain.

        • lastUpdatedAt — (Date)

          A timestamp of when a Amazon DataZone domain was last updated.

        • managedAccountIdrequired — (String)

          The identifier of the Amazon Web Services account that manages the domain.

        • namerequired — (String)

          A name of an Amazon DataZone domain.

        • portalUrl — (String)

          The data portal URL for the Amazon DataZone domain.

        • statusrequired — (String)

          The status of the Amazon DataZone domain.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "CREATION_FAILED"
          • "DELETING"
          • "DELETED"
          • "DELETION_FAILED"
      • nextToken — (String)

        When the number of domains is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domains, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomains to list the next set of domains.

Returns:

  • (AWS.Request)

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

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

Lists child domain units for the specified parent domain unit.

Service Reference:

Examples:

Calling the listDomainUnitsForParent operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  parentDomainUnitIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listDomainUnitsForParent(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 domain in which you want to list domain units for a parent domain unit.

    • maxResults — (Integer)

      The maximum number of domain units to return in a single call to ListDomainUnitsForParent. When the number of domain units to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

    • nextToken — (String)

      When the number of domain units is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

    • parentDomainUnitIdentifier — (String)

      The ID of the parent domain unit.

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:

      • items — (Array<map>)

        The results returned by this action.

        • idrequired — (String)

          The ID of the domain unit summary.

        • namerequired — (String)

          The name of the domain unit summary.

      • nextToken — (String)

        When the number of domain units is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of domain units, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set of domain units.

Returns:

  • (AWS.Request)

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

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

Lists the entity (domain units) owners.

Service Reference:

Examples:

Calling the listEntityOwners operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: DOMAIN_UNIT, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listEntityOwners(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 domain where you want to list entity owners.

    • entityIdentifier — (String)

      The ID of the entity that you want to list.

    • entityType — (String)

      The type of the entity that you want to list.

      Possible values include:
      • "DOMAIN_UNIT"
    • maxResults — (Integer)

      The maximum number of entities to return in a single call to ListEntityOwners. When the number of entities to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEntityOwners to list the next set of entities.

    • nextToken — (String)

      When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • nextToken — (String)

        When the number of entities is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of entities, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEntityOwners to list the next set of entities.

      • owners — (Array<map>)

        The owners of the entity.

        • group — (map)

          Specifies that the domain unit owner is a group.

          • groupId — (String)

            The ID of the domain unit owners group.

        • user — (map)

          Specifies that the domain unit owner is a user.

          • userId — (String)

            The ID of the owner user.

Returns:

  • (AWS.Request)

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

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

Lists existing environment actions.

Service Reference:

Examples:

Calling the listEnvironmentActions operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listEnvironmentActions(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 actions are listed.

    • environmentIdentifier — (String)

      The ID of the envrironment whose environment actions are listed.

    • maxResults — (Integer)

      The maximum number of environment actions to return in a single call to ListEnvironmentActions. When the number of environment actions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

    • nextToken — (String)

      When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

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:

      • items — (Array<map>)

        The results of ListEnvironmentActions.

        • description — (String)

          The environment action description.

        • domainIdrequired — (String)

          The Amazon DataZone domain ID of the environment action.

        • environmentIdrequired — (String)

          The environment ID of the environment action.

        • idrequired — (String)

          The ID of the environment action.

        • namerequired — (String)

          The name of the environment action.

        • parametersrequired — (map)

          The parameters of the environment action.

          • awsConsoleLink — (map)

            The console link specified as part of the environment action.

            • uri — (String)

              The URI of the console link specified as part of the environment action.

      • nextToken — (String)

        When the number of environment actions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment actions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentActions to list the next set of environment actions.

Returns:

  • (AWS.Request)

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

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

Lists blueprint configurations for a Amazon DataZone environment.

Examples:

Calling the listEnvironmentBlueprintConfigurations operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listEnvironmentBlueprintConfigurations(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 identifier of the Amazon DataZone domain.

    • maxResults — (Integer)

      The maximum number of blueprint configurations to return in a single call to ListEnvironmentBlueprintConfigurations. When the number of configurations to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

    • nextToken — (String)

      When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

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:

      • items — (Array<map>)

        The results of the ListEnvironmentBlueprintConfigurations action.

        • createdAt — (Date)

          The timestamp of when an environment blueprint was created.

        • domainIdrequired — (String)

          The identifier of the Amazon DataZone domain in which an environment blueprint exists.

        • enabledRegions — (Array<String>)

          The enabled Amazon Web Services Regions specified in a blueprint configuration.

        • environmentBlueprintIdrequired — (String)

          The identifier of the environment blueprint.

        • manageAccessRoleArn — (String)

          The ARN of the manage access role specified in the environment blueprint configuration.

        • provisioningConfigurations — (Array<map>)

          The provisioning configuration of a blueprint.

          • lakeFormationConfiguration — (map)

            The Lake Formation configuration of the Data Lake blueprint.

            • locationRegistrationExcludeS3Locations — (Array<String>)

              Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

            • locationRegistrationRole — (String)

              The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.

        • provisioningRoleArn — (String)

          The ARN of the provisioning role specified in the environment blueprint configuration.

        • regionalParameters — (map<map<String>>)

          The regional parameters of the environment blueprint.

        • updatedAt — (Date)

          The timestamp of when the environment blueprint was updated.

      • nextToken — (String)

        When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

Returns:

  • (AWS.Request)

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

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

Lists blueprints in an Amazon DataZone environment.

Service Reference:

Examples:

Calling the listEnvironmentBlueprints operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  managed: true || false,
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listEnvironmentBlueprints(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 identifier of the Amazon DataZone domain.

    • managed — (Boolean)

      Specifies whether the environment blueprint is managed by Amazon DataZone.

    • maxResults — (Integer)

      The maximum number of blueprints to return in a single call to ListEnvironmentBlueprints. When the number of blueprints to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentBlueprints to list the next set of blueprints.

    • name — (String)

      The name of the Amazon DataZone environment.

    • nextToken — (String)

      When the number of blueprints in the environment is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.

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:

      • items — (Array<map>)

        The results of the ListEnvironmentBlueprints action.

        • createdAt — (Date)

          The timestamp of when an environment blueprint was created.

        • description — (String)

          The description of a blueprint.

        • idrequired — (String)

          The identifier of the blueprint.

        • namerequired — (String)

          The name of the blueprint.

        • providerrequired — (String)

          The provider of the blueprint.

        • provisioningPropertiesrequired — (map)

          The provisioning properties of the blueprint.

          • cloudFormation — (map)

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

            • templateUrlrequired — (String)

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

        • updatedAt — (Date)

          The timestamp of when the blueprint was enabled.

      • nextToken — (String)

        When the number of blueprints in the environment is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.

Returns:

  • (AWS.Request)

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

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

Lists Amazon DataZone environment profiles.

Service Reference:

Examples:

Calling the listEnvironmentProfiles operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  awsAccountId: 'STRING_VALUE',
  awsAccountRegion: 'STRING_VALUE',
  environmentBlueprintIdentifier: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  projectIdentifier: 'STRING_VALUE'
};
datazone.listEnvironmentProfiles(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 identifier of the Amazon Web Services account where you want to list environment profiles.

    • awsAccountRegion — (String)

      The Amazon Web Services region where you want to list environment profiles.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain.

    • environmentBlueprintIdentifier — (String)

      The identifier of the blueprint that was used to create the environment profiles that you want to list.

    • maxResults — (Integer)

      The maximum number of environment profiles to return in a single call to ListEnvironmentProfiles. When the number of environment profiles to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

    • name — (String)

    • nextToken — (String)

      When the number of environment profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

    • projectIdentifier — (String)

      The identifier 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:

      • items — (Array<map>)

        The results of the ListEnvironmentProfiles action.

        • awsAccountId — (String)

          The identifier of an Amazon Web Services account in which an environment profile exists.

        • awsAccountRegion — (String)

          The Amazon Web Services Region in which an environment profile exists.

        • createdAt — (Date)

          The timestamp of when an environment profile was created.

        • createdByrequired — (String)

          The Amazon DataZone user who created the environment profile.

        • description — (String)

          The description of the environment profile.

        • domainIdrequired — (String)

          The identifier of the Amazon DataZone domain in which the environment profile exists.

        • environmentBlueprintIdrequired — (String)

          The identifier of a blueprint with which an environment profile is created.

        • idrequired — (String)

          The identifier of the environment profile.

        • namerequired — (String)

          The name of the environment profile.

        • projectId — (String)

          The identifier of a project in which an environment profile exists.

        • updatedAt — (Date)

          The timestamp of when the environment profile was updated.

      • nextToken — (String)

        When the number of environment profiles is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.

Returns:

  • (AWS.Request)

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

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

Lists Amazon DataZone environments.

Service Reference:

Examples:

Calling the listEnvironments operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  projectIdentifier: 'STRING_VALUE', /* required */
  awsAccountId: 'STRING_VALUE',
  awsAccountRegion: 'STRING_VALUE',
  environmentBlueprintIdentifier: 'STRING_VALUE',
  environmentProfileIdentifier: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  provider: 'STRING_VALUE',
  status: ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | VALIDATION_FAILED | SUSPENDED | DISABLED | EXPIRED | DELETED | INACCESSIBLE
};
datazone.listEnvironments(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 identifier of the Amazon Web Services account where you want to list environments.

    • awsAccountRegion — (String)

      The Amazon Web Services region where you want to list environments.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain.

    • environmentBlueprintIdentifier — (String)

      The identifier of the Amazon DataZone blueprint.

    • environmentProfileIdentifier — (String)

      The identifier of the environment profile.

    • maxResults — (Integer)

      The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.

    • name — (String)

      The name of the environment.

    • nextToken — (String)

      When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

    • projectIdentifier — (String)

      The identifier of the Amazon DataZone project.

    • provider — (String)

      The provider of the environment.

    • status — (String)

      The status of the environments that you want to list.

      Possible values include:
      • "ACTIVE"
      • "CREATING"
      • "UPDATING"
      • "DELETING"
      • "CREATE_FAILED"
      • "UPDATE_FAILED"
      • "DELETE_FAILED"
      • "VALIDATION_FAILED"
      • "SUSPENDED"
      • "DISABLED"
      • "EXPIRED"
      • "DELETED"
      • "INACCESSIBLE"

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:

      • items — (Array<map>)

        The results of the ListEnvironments action.

        • awsAccountId — (String)

          The identifier of the Amazon Web Services account in which an environment exists.

        • awsAccountRegion — (String)

          The Amazon Web Services Region in which an environment exists.

        • createdAt — (Date)

          The timestamp of when the environment was created.

        • createdByrequired — (String)

          The Amazon DataZone user who created the environment.

        • description — (String)

          The description of the environment.

        • domainIdrequired — (String)

          The identifier of the Amazon DataZone domain in which the environment exists.

        • environmentProfileId — (String)

          The identifier of the environment profile with which the environment was created.

        • id — (String)

          The identifier of the environment.

        • namerequired — (String)

          The name of the environment.

        • projectIdrequired — (String)

          The identifier of the project in which the environment exists.

        • providerrequired — (String)

          The provider of the environment.

        • status — (String)

          The status of the 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 the environment was updated.

      • nextToken — (String)

        When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.

Returns:

  • (AWS.Request)

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

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

Lists the history of the specified data lineage node.

Service Reference:

Examples:

Calling the listLineageNodeHistory operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  direction: UPSTREAM | DOWNSTREAM,
  eventTimestampGTE: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  eventTimestampLTE: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortOrder: ASCENDING | DESCENDING
};
datazone.listLineageNodeHistory(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: {})
    • direction — (String)

      The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.

      Possible values include:
      • "UPSTREAM"
      • "DOWNSTREAM"
    • domainIdentifier — (String)

      The ID of the domain where you want to list the history of the specified data lineage node.

    • eventTimestampGTE — (Date)

      Specifies whether the action is to return data lineage node history from the time after the event timestamp.

    • eventTimestampLTE — (Date)

      Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

    • identifier — (String)

      The ID of the data lineage node whose history you want to list.

    • maxResults — (Integer)

      The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.

    • nextToken — (String)

      When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

    • sortOrder — (String)

      The order by which you want data lineage node history to be sorted.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • nextToken — (String)

        When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

      • nodes — (Array<map>)

        The nodes returned by the ListLineageNodeHistory action.

        • createdAt — (Date)

          The timestamp at which the data lineage node was created.

        • createdBy — (String)

          The user who created the data lineage node.

        • description — (String)

          The description of the data lineage node.

        • domainIdrequired — (String)

          The ID of the domain of the data lineage node.

        • eventTimestamp — (Date)

          The event timestamp of the data lineage node.

        • idrequired — (String)

          The ID of the data lineage node.

        • name — (String)

          The name of the data lineage node.

        • sourceIdentifier — (String)

          The alternate ID of the data lineage node.

        • typeNamerequired — (String)

          The name of the type of the data lineage node.

        • typeRevision — (String)

          The type of the revision of the data lineage node.

        • updatedAt — (Date)

          The timestamp at which the data lineage node was updated.

        • updatedBy — (String)

          The user who updated the data lineage node.

Returns:

  • (AWS.Request)

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

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

Lists all metadata generation runs.

Service Reference:

Examples:

Calling the listMetadataGenerationRuns operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  status: SUBMITTED | IN_PROGRESS | CANCELED | SUCCEEDED | FAILED,
  type: BUSINESS_DESCRIPTIONS
};
datazone.listMetadataGenerationRuns(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 where you want to list metadata generation runs.

    • maxResults — (Integer)

      The maximum number of metadata generation runs to return in a single call to ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

    • nextToken — (String)

      When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

    • status — (String)

      The status of the metadata generation runs.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "CANCELED"
      • "SUCCEEDED"
      • "FAILED"
    • type — (String)

      The type of the metadata generation runs.

      Possible values include:
      • "BUSINESS_DESCRIPTIONS"

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:

      • items — (Array<map>)

        The results of the ListMetadataGenerationRuns action.

        • createdAt — (Date)

          The timestamp at which the metadata generation run was created.

        • createdBy — (String)

          The user who created the metadata generation run.

        • domainIdrequired — (String)

          The ID of the Amazon DataZone domain in which the metadata generation run was created.

        • idrequired — (String)

          The ID of the metadata generation run.

        • owningProjectIdrequired — (String)

          The ID of the project that owns the asset for which the metadata generation was ran.

        • status — (String)

          The status of the metadata generation run.

          Possible values include:
          • "SUBMITTED"
          • "IN_PROGRESS"
          • "CANCELED"
          • "SUCCEEDED"
          • "FAILED"
        • target — (map)

          The asset for which metadata was generated.

          • identifierrequired — (String)

            The ID of the metadata generation run's target.

          • revision — (String)

            The revision of the asset for which metadata was generated.

          • typerequired — (String)

            The type of the asset for which metadata was generated.

            Possible values include:
            • "ASSET"
        • type — (String)

          The type of the metadata generation run.

          Possible values include:
          • "BUSINESS_DESCRIPTIONS"
      • nextToken — (String)

        When the number of metadata generation runs is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of metadata generation runs, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListMetadataGenerationRuns to list the next set of revisions.

Returns:

  • (AWS.Request)

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

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

Lists all Amazon DataZone notifications.

Service Reference:

Examples:

Calling the listNotifications operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  type: TASK | EVENT, /* required */
  afterTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  beforeTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  subjects: [
    'STRING_VALUE',
    /* more items */
  ],
  taskStatus: ACTIVE | INACTIVE
};
datazone.listNotifications(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: {})
    • afterTimestamp — (Date)

      The time after which you want to list notifications.

    • beforeTimestamp — (Date)

      The time before which you want to list notifications.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain.

    • maxResults — (Integer)

      The maximum number of notifications to return in a single call to ListNotifications. When the number of notifications to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListNotifications to list the next set of notifications.

    • nextToken — (String)

      When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

    • subjects — (Array<String>)

      The subjects of notifications.

    • taskStatus — (String)

      The task status of notifications.

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

      The type of notifications.

      Possible values include:
      • "TASK"
      • "EVENT"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • nextToken — (String)

        When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

      • notifications — (Array<map>)

        The results of the ListNotifications action.

        • actionLinkrequired — (String)

          The action link included in the notification.

        • creationTimestamprequired — (Date)

          The timestamp of when a notification was created.

        • domainIdentifierrequired — (String)

          The identifier of a Amazon DataZone domain in which the notification exists.

        • identifierrequired — (String)

          The identifier of the notification.

        • lastUpdatedTimestamprequired — (Date)

          The timestamp of when the notification was last updated.

        • messagerequired — (String)

          The message included in the notification.

        • metadata — (map<String>)

          The metadata included in the notification.

        • status — (String)

          The status included in the notification.

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

          The title of the notification.

        • topicrequired — (map)

          The topic of the notification.

          • resourcerequired — (map)

            The details of the resource mentioned in a notification.

            • idrequired — (String)

              The ID of the resource mentioned in a notification.

            • name — (String)

              The name of the resource mentioned in a notification.

            • typerequired — (String)

              The type of the resource mentioned in a notification.

              Possible values include:
              • "PROJECT"
          • rolerequired — (String)

            The role of the resource mentioned in a notification.

            Possible values include:
            • "PROJECT_OWNER"
            • "PROJECT_CONTRIBUTOR"
            • "PROJECT_VIEWER"
            • "DOMAIN_OWNER"
            • "PROJECT_SUBSCRIBER"
          • subjectrequired — (String)

            The subject of the resource mentioned in a notification.

        • typerequired — (String)

          The type of the notification.

          Possible values include:
          • "TASK"
          • "EVENT"

Returns:

  • (AWS.Request)

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

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

Lists policy grants.

Service Reference:

Examples:

Calling the listPolicyGrants operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE, /* required */
  policyType: CREATE_DOMAIN_UNIT | OVERRIDE_DOMAIN_UNIT_OWNERS | ADD_TO_PROJECT_MEMBER_POOL | OVERRIDE_PROJECT_OWNERS | CREATE_GLOSSARY | CREATE_FORM_TYPE | CREATE_ASSET_TYPE | CREATE_PROJECT | CREATE_ENVIRONMENT_PROFILE | DELEGATE_CREATE_ENVIRONMENT_PROFILE | CREATE_ENVIRONMENT, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
datazone.listPolicyGrants(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 domain where you want to list policy grants.

    • entityIdentifier — (String)

      The ID of the entity for which you want to list policy grants.

    • entityType — (String)

      The type of entity for which you want to list policy grants.

      Possible values include:
      • "DOMAIN_UNIT"
      • "ENVIRONMENT_BLUEPRINT_CONFIGURATION"
      • "ENVIRONMENT_PROFILE"
    • maxResults — (Integer)

      The maximum number of grants to return in a single call to ListPolicyGrants. When the number of grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListPolicyGrants to list the next set of grants.

    • nextToken — (String)

      When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

    • policyType — (String)

      The type of policy that you want to list.

      Possible values include:
      • "CREATE_DOMAIN_UNIT"
      • "OVERRIDE_DOMAIN_UNIT_OWNERS"
      • "ADD_TO_PROJECT_MEMBER_POOL"
      • "OVERRIDE_PROJECT_OWNERS"
      • "CREATE_GLOSSARY"
      • "CREATE_FORM_TYPE"
      • "CREATE_ASSET_TYPE"
      • "CREATE_PROJECT"
      • "CREATE_ENVIRONMENT_PROFILE"
      • "DELEGATE_CREATE_ENVIRONMENT_PROFILE"
      • "CREATE_ENVIRONMENT"

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:

      • grantList — (Array<map>)

        The results of this action - the listed grants.

        • createdAt — (Date)

          Specifies the timestamp at which policy grant member was created.

        • createdBy — (String)

          Specifies the user who created the policy grant member.

        • detail — (map)

          The details of the policy grant member.

          • addToProjectMemberPool — (map)

            Specifies that the policy grant is to be added to the members of the project.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy grant is applied to child domain units.

          • createAssetType — (map)

            Specifies that this is a create asset type policy.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy grant is applied to child domain units.

          • createDomainUnit — (map)

            Specifies that this is a create domain unit policy.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy grant is applied to child domain units.

          • createEnvironment — (map)

            Specifies that this is a create environment policy.

          • createEnvironmentProfile — (map)

            Specifies that this is a create environment profile policy.

            • domainUnitId — (String)

              The ID of the domain unit.

          • createFormType — (map)

            Specifies that this is a create form type policy.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy grant is applied to child domain units.

          • createGlossary — (map)

            Specifies that this is a create glossary policy.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy grant is applied to child domain units.

          • createProject — (map)

            Specifies that this is a create project policy.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy grant is applied to child domain units.

          • delegateCreateEnvironmentProfile — (map)

            Specifies that this is the delegation of the create environment profile policy.

          • overrideDomainUnitOwners — (map)

            Specifies whether to override domain unit owners.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy is inherited by child domain units.

          • overrideProjectOwners — (map)

            Specifies whether to override project owners.

            • includeChildDomainUnits — (Boolean)

              Specifies whether the policy is inherited by child domain units.

        • principal — (map)

          The principal of the policy grant member.

          • domainUnit — (map)

            The domain unit of the policy grant principal.

            • domainUnitDesignationrequired — (String)

              Specifes the designation of the domain unit users.

              Possible values include:
              • "OWNER"
            • domainUnitGrantFilter — (map)

              The grant filter for the domain unit.

              • allDomainUnitsGrantFilter — (map)

                Specifies a grant filter containing all domain units.

            • domainUnitIdentifier — (String)

              The ID of the domain unit.

          • group — (map)

            The group of the policy grant principal.

            • groupIdentifier — (String)

              The ID Of the group of the group principal.

          • project — (map)

            The project of the policy grant principal.

            • projectDesignationrequired — (String)

              The project designation of the project policy grant principal.

              Possible values include:
              • "OWNER"
              • "CONTRIBUTOR"
            • projectGrantFilter — (map)

              The project grant filter of the project policy grant principal.

              • domainUnitFilter — (map)

                The domain unit filter of the project grant filter.

                • domainUnitrequired — (String)

                  The domain unit ID to use in the filter.

                • includeChildDomainUnits — (Boolean)

                  Specifies whether to include child domain units.

            • projectIdentifier — (String)

              The project ID of the project policy grant principal.

          • user — (map)

            The user of the policy grant principal.

            • allUsersGrantFilter — (map)

              The all users grant filter of the user policy grant principal.

            • userIdentifier — (String)

              The user ID of the user policy grant principal.

      • nextToken — (String)

        When the number of grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListPolicyGrants to list the next set of grants.

Returns:

  • (AWS.Request)

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

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

Lists all members of the specified project.

Service Reference:

Examples:

Calling the listProjectMemberships operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  projectIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: NAME,
  sortOrder: ASCENDING | DESCENDING
};
datazone.listProjectMemberships(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 identifier of the Amazon DataZone domain in which you want to list project memberships.

    • maxResults — (Integer)

      The maximum number of memberships to return in a single call to ListProjectMemberships. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjectMemberships to list the next set of memberships.

    • nextToken — (String)

      When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

    • projectIdentifier — (String)

      The identifier of the project whose memberships you want to list.

    • sortBy — (String)

      The method by which you want to sort the project memberships.

      Possible values include:
      • "NAME"
    • sortOrder — (String)

      The sort order of the project memberships.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"

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:

      • members — (Array<map>)

        The members of the project.

        • designationrequired — (String)

          The designated role of a project member.

          Possible values include:
          • "PROJECT_OWNER"
          • "PROJECT_CONTRIBUTOR"
        • memberDetailsrequired — (map)

          The membership details of a project member.

          • group — (map)

            The group details of a project member.

            • groupIdrequired — (String)

              The identifier of the group in Amazon DataZone.

          • user — (map)

            The user details of a project member.

            • userIdrequired — (String)

              The identifier of the Amazon DataZone user.

      • nextToken — (String)

        When the number of memberships is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of memberships, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjectMemberships to list the next set of memberships.

Returns:

  • (AWS.Request)

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

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

Lists Amazon DataZone projects.

Service Reference:

Examples:

Calling the listProjects operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  groupIdentifier: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  userIdentifier: 'STRING_VALUE'
};
datazone.listProjects(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 identifier of the Amazon DataZone domain.

    • groupIdentifier — (String)

      The identifier of a group.

    • maxResults — (Integer)

      The maximum number of projects to return in a single call to ListProjects. When the number of projects to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListProjects to list the next set of projects.

    • name — (String)

      The name of the project.

    • nextToken — (String)

      When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

    • userIdentifier — (String)

      The identifier of the Amazon DataZone 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:

      • items — (Array<map>)

        The results of the ListProjects action.

        • createdAt — (Date)

          The timestamp of when a project was created.

        • createdByrequired — (String)

          The Amazon DataZone user who created the project.

        • description — (String)

          The description of a project.

        • domainIdrequired — (String)

          The identifier of a Amazon DataZone domain where the project exists.

        • domainUnitId — (String)

          The ID of the domain unit.

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

        • idrequired — (String)

          The identifier of a project.

        • namerequired — (String)

          The name of a project.

        • projectStatus — (String)

          The status of the project.

          Possible values include:
          • "ACTIVE"
          • "DELETING"
          • "DELETE_FAILED"
        • updatedAt — (Date)

          The timestamp of when the project was updated.

      • nextToken — (String)

        When the number of projects is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of projects, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListProjects to list the next set of projects.

Returns:

  • (AWS.Request)

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

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

Lists subscription grants.

Service Reference:

Examples:

Calling the listSubscriptionGrants operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owningProjectId: 'STRING_VALUE',
  sortBy: CREATED_AT | UPDATED_AT,
  sortOrder: ASCENDING | DESCENDING,
  subscribedListingId: 'STRING_VALUE',
  subscriptionId: 'STRING_VALUE',
  subscriptionTargetId: 'STRING_VALUE'
};
datazone.listSubscriptionGrants(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 identifier of the Amazon DataZone domain.

    • environmentId — (String)

      The identifier of the Amazon DataZone environment.

    • maxResults — (Integer)

      The maximum number of subscription grants to return in a single call to ListSubscriptionGrants. When the number of subscription grants to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

    • nextToken — (String)

      When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

    • owningProjectId — (String)

      The ID of the owning project of the subscription grants.

    • sortBy — (String)

      Specifies the way of sorting the results of this action.

      Possible values include:
      • "CREATED_AT"
      • "UPDATED_AT"
    • sortOrder — (String)

      Specifies the sort order of this action.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • subscribedListingId — (String)

      The identifier of the subscribed listing.

    • subscriptionId — (String)

      The identifier of the subscription.

    • subscriptionTargetId — (String)

      The identifier 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:

      • items — (Array<map>)

        The results of the ListSubscriptionGrants action.

        • assets — (Array<map>)

          The assets included in the subscription grant.

          • assetIdrequired — (String)

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

          • assetRevisionrequired — (String)

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

          • assetScope — (map)

            The asset scope of the subscribed asset.

            • assetIdrequired — (String)

              The asset ID of the asset scope.

            • errorMessage — (String)

              The error message of the asset scope.

            • filterIdsrequired — (Array<String>)

              The filter IDs of the asset scope.

            • statusrequired — (String)

              The status of the asset scope.

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

          • statusrequired — (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.

        • createdAtrequired — (Date)

          The timestamp of when a subscription grant was created.

        • createdByrequired — (String)

          The datazone user who created the subscription grant.

        • domainIdrequired — (String)

          The identifier of the Amazon DataZone domain in which a subscription grant exists.

        • grantedEntityrequired — (map)

          The entity to which the subscription is granted.

          • listing — (map)

            The listing for which a subscription is granted.

            • idrequired — (String)

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

            • revisionrequired — (String)

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

        • idrequired — (String)

          The identifier of the subscription grant.

        • statusrequired — (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 ID of the subscription.

        • subscriptionTargetIdrequired — (String)

          The identifier of the target of the subscription grant.

        • updatedAtrequired — (Date)

          The timestampf of when the subscription grant was updated.

        • updatedBy — (String)

          The Amazon DataZone user who updated the subscription grant.

      • nextToken — (String)

        When the number of subscription grants is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription grants, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionGrants to list the next set of subscription grants.

Returns:

  • (AWS.Request)

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

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

Lists Amazon DataZone subscription requests.

Service Reference:

Examples:

Calling the listSubscriptionRequests operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  approverProjectId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owningProjectId: 'STRING_VALUE',
  sortBy: CREATED_AT | UPDATED_AT,
  sortOrder: ASCENDING | DESCENDING,
  status: PENDING | ACCEPTED | REJECTED,
  subscribedListingId: 'STRING_VALUE'
};
datazone.listSubscriptionRequests(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: {})
    • approverProjectId — (String)

      The identifier of the subscription request approver's project.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain.

    • maxResults — (Integer)

      The maximum number of subscription requests to return in a single call to ListSubscriptionRequests. When the number of subscription requests to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

    • nextToken — (String)

      When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

    • owningProjectId — (String)

      The identifier of the project for the subscription requests.

    • sortBy — (String)

      Specifies the way to sort the results of this action.

      Possible values include:
      • "CREATED_AT"
      • "UPDATED_AT"
    • sortOrder — (String)

      Specifies the sort order for the results of this action.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • status — (String)

      Specifies the status of the subscription requests.

      Note: This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.
      Possible values include:
      • "PENDING"
      • "ACCEPTED"
      • "REJECTED"
    • subscribedListingId — (String)

      The identifier of the subscribed listing.

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:

      • items — (Array<map>)

        The results of the ListSubscriptionRequests action.

        • createdAtrequired — (Date)

          The timestamp of when a subscription request was created.

        • createdByrequired — (String)

          The Amazon DataZone user who created the subscription request.

        • decisionComment — (String)

          The decision comment of the subscription request.

        • domainIdrequired — (String)

          The identifier of the Amazon DataZone domain in which a subscription request exists.

        • idrequired — (String)

          The identifier of the subscription request.

        • requestReasonrequired — (String)

          The reason for the subscription request.

        • reviewerId — (String)

          The identifier of the subscription request reviewer.

        • statusrequired — (String)

          The status of the subscription request.

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

          The listings included in the subscription request.

          • descriptionrequired — (String)

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

          • idrequired — (String)

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

          • itemrequired — (map)

            The published asset for which the subscription grant is created.

            • assetListing — (map)

              The asset for which the subscription grant is created.

              • assetScope — (map)

                The asset scope of the subscribed asset listing.

                • assetIdrequired — (String)

                  The asset ID of the asset scope.

                • errorMessage — (String)

                  The error message of the asset scope.

                • filterIdsrequired — (Array<String>)

                  The filter IDs of the asset scope.

                • statusrequired — (String)

                  The status of the asset scope.

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

            • productListing — (map)

              The data product listing.

              • assetListings — (Array<map>)

                The data assets of the data product listing.

                • entityId — (String)

                  The entity ID of the listing of the asset in a data product.

                • entityRevision — (String)

                  The entity revision of the listing of the asset in a data product.

                • entityType — (String)

                  The entity type of the listing of the asset in a data product.

              • description — (String)

                The description of the data product listing.

              • entityId — (String)

                The ID of the data product listing.

              • entityRevision — (String)

                The revision of the data product listing.

              • glossaryTerms — (Array<map>)

                The glossary terms of the data product listing.

                • 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 — (String)

                The name of the data product listing.

          • namerequired — (String)

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

          • ownerProjectIdrequired — (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.

        • subscribedPrincipalsrequired — (Array<map>)

          The principals included 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.

        • updatedAtrequired — (Date)

          The timestamp of when the subscription request was updated.

        • updatedBy — (String)

          The identifier of the Amazon DataZone user who updated the subscription request.

      • nextToken — (String)

        When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

Returns:

  • (AWS.Request)

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

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

Lists subscriptions in Amazon DataZone.

Service Reference:

Examples:

Calling the listSubscriptions operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  approverProjectId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owningProjectId: 'STRING_VALUE',
  sortBy: CREATED_AT | UPDATED_AT,
  sortOrder: ASCENDING | DESCENDING,
  status: APPROVED | REVOKED | CANCELLED,
  subscribedListingId: 'STRING_VALUE',
  subscriptionRequestIdentifier: 'STRING_VALUE'
};
datazone.listSubscriptions(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: {})
    • approverProjectId — (String)

      The identifier of the project for the subscription's approver.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain.

    • maxResults — (Integer)

      The maximum number of subscriptions to return in a single call to ListSubscriptions. When the number of subscriptions to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptions to list the next set of Subscriptions.

    • nextToken — (String)

      When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

    • owningProjectId — (String)

      The identifier of the owning project.

    • sortBy — (String)

      Specifies the way in which the results of this action are to be sorted.

      Possible values include:
      • "CREATED_AT"
      • "UPDATED_AT"
    • sortOrder — (String)

      Specifies the sort order for the results of this action.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"
    • status — (String)

      The status of the subscriptions that you want to list.

      Note: This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.
      Possible values include:
      • "APPROVED"
      • "REVOKED"
      • "CANCELLED"
    • subscribedListingId — (String)

      The identifier of the subscribed listing for the subscriptions that you want to list.

    • subscriptionRequestIdentifier — (String)

      The identifier of the subscription request for the subscriptions that you want to list.

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:

      • items — (Array<map>)

        The results of the ListSubscriptions action.

        • createdAtrequired — (Date)

          The timestamp of when the subscription was created.

        • createdByrequired — (String)

          The Amazon DataZone user who created the subscription.

        • domainIdrequired — (String)

          The identifier of the Amazon DataZone domain in which a subscription exists.

        • idrequired — (String)

          The identifier of the subscription.

        • retainPermissions — (Boolean)

          The retain permissions included in the subscription.

        • statusrequired — (String)

          The status of the subscription.

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

          The listing included in the subscription.

          • descriptionrequired — (String)

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

          • idrequired — (String)

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

          • itemrequired — (map)

            The published asset for which the subscription grant is created.

            • assetListing — (map)

              The asset for which the subscription grant is created.

              • assetScope — (map)

                The asset scope of the subscribed asset listing.

                • assetIdrequired — (String)

                  The asset ID of the asset scope.

                • errorMessage — (String)

                  The error message of the asset scope.

                • filterIdsrequired — (Array<String>)

                  The filter IDs of the asset scope.

                • statusrequired — (String)

                  The status of the asset scope.

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

            • productListing — (map)

              The data product listing.

              • assetListings — (Array<map>)

                The data assets of the data product listing.

                • entityId — (String)

                  The entity ID of the listing of the asset in a data product.

                • entityRevision — (String)

                  The entity revision of the listing of the asset in a data product.

                • entityType — (String)

                  The entity type of the listing of the asset in a data product.

              • description — (String)

                The description of the data product listing.

              • entityId — (String)

                The ID of the data product listing.

              • entityRevision — (String)

                The revision of the data product listing.

              • glossaryTerms — (Array<map>)

                The glossary terms of the data product listing.

                • 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 — (String)

                The name of the data product listing.

          • namerequired — (String)

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

          • ownerProjectIdrequired — (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.

        • subscribedPrincipalrequired — (map)

          The principal included in the subscription.

          • 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 identifier of the subscription request for the subscription.

        • updatedAtrequired — (Date)

          The timestamp of when the subscription was updated.

        • updatedBy — (String)

          The Amazon DataZone user who updated the subscription.

      • nextToken — (String)

        When the number of subscriptions is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscriptions, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptions to list the next set of subscriptions.

Returns:

  • (AWS.Request)

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

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

Lists subscription targets in Amazon DataZone.

Service Reference:

Examples:

Calling the listSubscriptionTargets operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  environmentIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: CREATED_AT | UPDATED_AT,
  sortOrder: ASCENDING | DESCENDING
};
datazone.listSubscriptionTargets(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 identifier of the Amazon DataZone domain where you want to list subscription targets.

    • environmentIdentifier — (String)

      The identifier of the environment where you want to list subscription targets.

    • maxResults — (Integer)

      The maximum number of subscription targets to return in a single call to ListSubscriptionTargets. When the number of subscription targets to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

    • nextToken — (String)

      When the number of subscription targets is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

    • sortBy — (String)

      Specifies the way in which the results of this action are to be sorted.

      Possible values include:
      • "CREATED_AT"
      • "UPDATED_AT"
    • sortOrder — (String)

      Specifies the sort order for the results of this action.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"

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:

      • items — (Array<map>)

        The results of the ListSubscriptionTargets action.

        • applicableAssetTypesrequired — (Array<String>)

          The asset types included in the subscription target.

        • authorizedPrincipalsrequired — (Array<String>)

          The authorized principals included in the subscription target.

        • createdAtrequired — (Date)

          The timestamp of when the subscription target was created.

        • createdByrequired — (String)

          The Amazon DataZone user who created the subscription target.

        • domainIdrequired — (String)

          The identifier of the Amazon DataZone domain in which the subscription target exists.

        • environmentIdrequired — (String)

          The identifier of the environment of the subscription target.

        • idrequired — (String)

          The identifier of the subscription target.

        • manageAccessRolerequired — (String)

          The manage access role specified in the subscription target.

        • namerequired — (String)

          The name of the subscription target.

        • projectIdrequired — (String)

          The identifier of the project specified in the subscription target.

        • providerrequired — (String)

          The provider of the subscription target.

        • subscriptionTargetConfigrequired — (Array<map>)

          The configuration of the subscription target.

          • contentrequired — (String)

            The content of the subscription target configuration.

          • formNamerequired — (String)

            The form name included in the subscription target configuration.

        • typerequired — (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.

      • nextToken — (String)

        When the number of subscription targets is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription targets, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionTargets to list the next set of subscription targets.

Returns:

  • (AWS.Request)

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

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

Lists tags for the specified resource in Amazon DataZone.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

Parameters:

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

      The ARN of the resource whose tags you want to list.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • tags — (map<String>)

        The tags of the specified resource.

Returns:

  • (AWS.Request)

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

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

Lists time series data points.

Service Reference:

Examples:

Calling the listTimeSeriesDataPoints operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: ASSET | LISTING, /* required */
  formName: 'STRING_VALUE', /* required */
  endedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  startedAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
datazone.listTimeSeriesDataPoints(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 that houses the assets for which you want to list time series data points.

    • endedAt — (Date)

      The timestamp at which the data points that you wanted to list ended.

    • entityIdentifier — (String)

      The ID of the asset for which you want to list data points.

    • entityType — (String)

      The type of the asset for which you want to list data points.

      Possible values include:
      • "ASSET"
      • "LISTING"
    • formName — (String)

      The name of the time series data points form.

    • maxResults — (Integer)

      The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

    • nextToken — (String)

      When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

    • startedAt — (Date)

      The timestamp at which the data points that you want to list started.

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:

      • items — (Array<map>)

        The results of the ListTimeSeriesDataPoints action.

        • contentSummary — (String)

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

        • formNamerequired — (String)

          The name of the time series data points summary form.

        • id — (String)

          The ID of the time series data points summary form.

        • timestamprequired — (Date)

          The timestamp of the time series data points summary form.

        • typeIdentifierrequired — (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.

      • nextToken — (String)

        When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

Returns:

  • (AWS.Request)

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

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

Posts a data lineage event.

Service Reference:

Examples:

Calling the postLineageEvent operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  event: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  clientToken: 'STRING_VALUE'
};
datazone.postLineageEvent(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 domain where you want to post a data lineage event.

    • event — (Buffer, Typed Array, Blob, String)

      The data lineage event that you want to post. Only open-lineage run event are supported as events.

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.

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

Posts time series data points to Amazon DataZone for the specified asset.

Service Reference:

Examples:

Calling the postTimeSeriesDataPoints operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: ASSET | LISTING, /* required */
  forms: [ /* required */
    {
      formName: 'STRING_VALUE', /* required */
      timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      typeIdentifier: 'STRING_VALUE', /* required */
      content: 'STRING_VALUE',
      typeRevision: 'STRING_VALUE'
    },
    /* more items */
  ],
  clientToken: 'STRING_VALUE'
};
datazone.postTimeSeriesDataPoints(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 you want to post time series data points.

    • entityIdentifier — (String)

      The ID of the asset for which you want to post time series data points.

    • entityType — (String)

      The type of the asset for which you want to post data points.

      Possible values include:
      • "ASSET"
      • "LISTING"
    • forms — (Array<map>)

      The forms that contain the data points that you want to post.

      • content — (String)

        The content of the time series data points form.

      • formNamerequired — (String)

        The name of the time series data points form.

      • timestamprequired — (Date)

        The timestamp of the time series data points form.

      • typeIdentifierrequired — (String)

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

      • typeRevision — (String)

        The revision type of the time series data points form.

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 you want to post time series data points.

      • entityId — (String)

        The ID of the asset for which you want to post time series data points.

      • entityType — (String)

        The type of the asset for which you want to post data points.

        Possible values include:
        • "ASSET"
        • "LISTING"
      • forms — (Array<map>)

        The forms that contain the data points that you have posted.

        • content — (String)

          The content of the time series data points form.

        • formNamerequired — (String)

          The name of the time series data points form.

        • id — (String)

          The ID of the time series data points form.

        • timestamprequired — (Date)

          The timestamp of the time series data points form.

        • typeIdentifierrequired — (String)

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

        • typeRevision — (String)

          The revision type of the time series data points form.

Returns:

  • (AWS.Request)

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

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

Writes the configuration for the specified environment blueprint in Amazon DataZone.

Examples:

Calling the putEnvironmentBlueprintConfiguration operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  enabledRegions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  environmentBlueprintIdentifier: 'STRING_VALUE', /* required */
  manageAccessRoleArn: 'STRING_VALUE',
  provisioningConfigurations: [
    {
      lakeFormationConfiguration: {
        locationRegistrationExcludeS3Locations: [
          'STRING_VALUE',
          /* more items */
        ],
        locationRegistrationRole: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  provisioningRoleArn: 'STRING_VALUE',
  regionalParameters: {
    '<RegionName>': {
      '<String>': 'STRING_VALUE',
      /* '<String>': ... */
    },
    /* '<RegionName>': ... */
  }
};
datazone.putEnvironmentBlueprintConfiguration(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 identifier of the Amazon DataZone domain.

    • enabledRegions — (Array<String>)

      Specifies the enabled Amazon Web Services Regions.

    • environmentBlueprintIdentifier — (String)

      The identifier of the environment blueprint.

    • manageAccessRoleArn — (String)

      The ARN of the manage access role.

    • provisioningConfigurations — (Array<map>)

      The provisioning configuration of a blueprint.

      • lakeFormationConfiguration — (map)

        The Lake Formation configuration of the Data Lake blueprint.

        • locationRegistrationExcludeS3Locations — (Array<String>)

          Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

        • locationRegistrationRole — (String)

          The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.

    • provisioningRoleArn — (String)

      The ARN of the provisioning role.

    • regionalParameters — (map<map<String>>)

      The regional parameters in the environment blueprint.

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 environment blueprint was created.

      • domainId — (String)

        The identifier of the Amazon DataZone domain.

      • enabledRegions — (Array<String>)

        Specifies the enabled Amazon Web Services Regions.

      • environmentBlueprintId — (String)

        The identifier of the environment blueprint.

      • manageAccessRoleArn — (String)

        The ARN of the manage access role.

      • provisioningConfigurations — (Array<map>)

        The provisioning configuration of a blueprint.

        • lakeFormationConfiguration — (map)

          The Lake Formation configuration of the Data Lake blueprint.

          • locationRegistrationExcludeS3Locations — (Array<String>)

            Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.

          • locationRegistrationRole — (String)

            The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.

      • provisioningRoleArn — (String)

        The ARN of the provisioning role.

      • regionalParameters — (map<map<String>>)

        The regional parameters in the environment blueprint.

      • updatedAt — (Date)

        The timestamp of when the environment blueprint was updated.

Returns:

  • (AWS.Request)

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

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

Rejects automatically generated business-friendly metadata for your Amazon DataZone assets.

Service Reference:

Examples:

Calling the rejectPredictions operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  rejectChoices: [
    {
      predictionTarget: 'STRING_VALUE', /* required */
      predictionChoices: [
        'NUMBER_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  rejectRule: {
    rule: ALL | NONE,
    threshold: 'NUMBER_VALUE'
  },
  revision: 'STRING_VALUE'
};
datazone.rejectPredictions(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.

    • identifier — (String)

      The identifier of the prediction.

    • rejectChoices — (Array<map>)

      Specifies the prediction (aka, the automatically generated piece of metadata) and the target (for example, a column name) that can be rejected.

      • predictionChoices — (Array<Integer>)

        Specifies the the automatically generated business metadata that can be rejected.

      • predictionTargetrequired — (String)

        Specifies the target (for example, a column name) where a prediction can be rejected.

    • rejectRule — (map)

      Specifies the rule (or the conditions) under which a prediction can be rejected.

      • rule — (String)

        Specifies whether you want to reject the top prediction for all targets or none.

        Possible values include:
        • "ALL"
        • "NONE"
      • threshold — (Float)

        The confidence score that specifies the condition at which a prediction can be rejected.

    • revision — (String)

      The revision that is to be made to 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:

      • assetId — (String)

        The ID of the asset.

      • assetRevision — (String)

        The revision that is to be made to the asset.

      • domainId — (String)

        The ID of the Amazon DataZone domain.

Returns:

  • (AWS.Request)

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

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

Rejects the specified subscription request.

Service Reference:

Examples:

Calling the rejectSubscriptionRequest operation

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

      The decision comment of the rejected subscription request.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain in which the subscription request was rejected.

    • identifier — (String)

      The identifier of the subscription request that was rejected.

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 subscription request was rejected.

      • createdBy — (String)

        The timestamp of when the subscription request was rejected.

      • decisionComment — (String)

        The decision comment of the rejected subscription request.

      • domainId — (String)

        The identifier of the Amazon DataZone domain in which the subscription request was rejected.

      • id — (String)

        The identifier of the subscription request that was rejected.

      • requestReason — (String)

        The reason for the subscription request.

      • reviewerId — (String)

        The identifier of the subscription request reviewer.

      • status — (String)

        The status of the subscription request.

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

        The subscribed listings of the subscription request.

        • descriptionrequired — (String)

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

        • idrequired — (String)

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

        • itemrequired — (map)

          The published asset for which the subscription grant is created.

          • assetListing — (map)

            The asset for which the subscription grant is created.

            • assetScope — (map)

              The asset scope of the subscribed asset listing.

              • assetIdrequired — (String)

                The asset ID of the asset scope.

              • errorMessage — (String)

                The error message of the asset scope.

              • filterIdsrequired — (Array<String>)

                The filter IDs of the asset scope.

              • statusrequired — (String)

                The status of the asset scope.

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

          • productListing — (map)

            The data product listing.

            • assetListings — (Array<map>)

              The data assets of the data product listing.

              • entityId — (String)

                The entity ID of the listing of the asset in a data product.

              • entityRevision — (String)

                The entity revision of the listing of the asset in a data product.

              • entityType — (String)

                The entity type of the listing of the asset in a data product.

            • description — (String)

              The description of the data product listing.

            • entityId — (String)

              The ID of the data product listing.

            • entityRevision — (String)

              The revision of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product listing.

              • 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 — (String)

              The name of the data product listing.

        • namerequired — (String)

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

        • ownerProjectIdrequired — (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.

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

Removes an owner from an entity.

Service Reference:

Examples:

Calling the removeEntityOwner operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: DOMAIN_UNIT, /* required */
  owner: { /* required */
    group: {
      groupIdentifier: 'STRING_VALUE' /* required */
    },
    user: {
      userIdentifier: 'STRING_VALUE' /* required */
    }
  },
  clientToken: 'STRING_VALUE'
};
datazone.removeEntityOwner(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 domain where you want to remove an owner from an entity.

    • entityIdentifier — (String)

      The ID of the entity from which you want to remove an owner.

    • entityType — (String)

      The type of the entity from which you want to remove an owner.

      Possible values include:
      • "DOMAIN_UNIT"
    • owner — (map)

      The owner that you want to remove from an entity.

      • group — (map)

        Specifies that the domain unit owner is a group.

        • groupIdentifierrequired — (String)

          The ID of the domain unit owners group.

      • user — (map)

        Specifies that the domain unit owner is a user.

        • userIdentifierrequired — (String)

          The ID of the owner 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.

Returns:

  • (AWS.Request)

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

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

Removes a policy grant.

Service Reference:

Examples:

Calling the removePolicyGrant operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  entityIdentifier: 'STRING_VALUE', /* required */
  entityType: DOMAIN_UNIT | ENVIRONMENT_BLUEPRINT_CONFIGURATION | ENVIRONMENT_PROFILE, /* required */
  policyType: CREATE_DOMAIN_UNIT | OVERRIDE_DOMAIN_UNIT_OWNERS | ADD_TO_PROJECT_MEMBER_POOL | OVERRIDE_PROJECT_OWNERS | CREATE_GLOSSARY | CREATE_FORM_TYPE | CREATE_ASSET_TYPE | CREATE_PROJECT | CREATE_ENVIRONMENT_PROFILE | DELEGATE_CREATE_ENVIRONMENT_PROFILE | CREATE_ENVIRONMENT, /* required */
  principal: { /* required */
    domainUnit: {
      domainUnitDesignation: OWNER, /* required */
      domainUnitGrantFilter: {
        allDomainUnitsGrantFilter: {
        }
      },
      domainUnitIdentifier: 'STRING_VALUE'
    },
    group: {
      groupIdentifier: 'STRING_VALUE'
    },
    project: {
      projectDesignation: OWNER | CONTRIBUTOR, /* required */
      projectGrantFilter: {
        domainUnitFilter: {
          domainUnit: 'STRING_VALUE', /* required */
          includeChildDomainUnits: true || false
        }
      },
      projectIdentifier: 'STRING_VALUE'
    },
    user: {
      allUsersGrantFilter: {
      },
      userIdentifier: 'STRING_VALUE'
    }
  },
  clientToken: 'STRING_VALUE'
};
datazone.removePolicyGrant(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 domain where you want to remove a policy grant.

    • entityIdentifier — (String)

      The ID of the entity from which you want to remove a policy grant.

    • entityType — (String)

      The type of the entity from which you want to remove a policy grant.

      Possible values include:
      • "DOMAIN_UNIT"
      • "ENVIRONMENT_BLUEPRINT_CONFIGURATION"
      • "ENVIRONMENT_PROFILE"
    • policyType — (String)

      The type of the policy that you want to remove.

      Possible values include:
      • "CREATE_DOMAIN_UNIT"
      • "OVERRIDE_DOMAIN_UNIT_OWNERS"
      • "ADD_TO_PROJECT_MEMBER_POOL"
      • "OVERRIDE_PROJECT_OWNERS"
      • "CREATE_GLOSSARY"
      • "CREATE_FORM_TYPE"
      • "CREATE_ASSET_TYPE"
      • "CREATE_PROJECT"
      • "CREATE_ENVIRONMENT_PROFILE"
      • "DELEGATE_CREATE_ENVIRONMENT_PROFILE"
      • "CREATE_ENVIRONMENT"
    • principal — (map)

      The principal from which you want to remove a policy grant.

      • domainUnit — (map)

        The domain unit of the policy grant principal.

        • domainUnitDesignationrequired — (String)

          Specifes the designation of the domain unit users.

          Possible values include:
          • "OWNER"
        • domainUnitGrantFilter — (map)

          The grant filter for the domain unit.

          • allDomainUnitsGrantFilter — (map)

            Specifies a grant filter containing all domain units.

        • domainUnitIdentifier — (String)

          The ID of the domain unit.

      • group — (map)

        The group of the policy grant principal.

        • groupIdentifier — (String)

          The ID Of the group of the group principal.

      • project — (map)

        The project of the policy grant principal.

        • projectDesignationrequired — (String)

          The project designation of the project policy grant principal.

          Possible values include:
          • "OWNER"
          • "CONTRIBUTOR"
        • projectGrantFilter — (map)

          The project grant filter of the project policy grant principal.

          • domainUnitFilter — (map)

            The domain unit filter of the project grant filter.

            • domainUnitrequired — (String)

              The domain unit ID to use in the filter.

            • includeChildDomainUnits — (Boolean)

              Specifies whether to include child domain units.

        • projectIdentifier — (String)

          The project ID of the project policy grant principal.

      • user — (map)

        The user of the policy grant principal.

        • allUsersGrantFilter — (map)

          The all users grant filter of the user policy grant principal.

        • userIdentifier — (String)

          The user ID of the user policy grant principal.

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.

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

Revokes a specified subscription in Amazon DataZone.

Service Reference:

Examples:

Calling the revokeSubscription operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  identifier: 'STRING_VALUE', /* required */
  retainPermissions: true || false
};
datazone.revokeSubscription(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 identifier of the Amazon DataZone domain where you want to revoke a subscription.

    • identifier — (String)

      The identifier of the revoked subscription.

    • retainPermissions — (Boolean)

      Specifies whether permissions are retained when the subscription is revoked.

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 subscription was revoked.

      • createdBy — (String)

        The identifier of the user who revoked the subscription.

      • domainId — (String)

        The identifier of the Amazon DataZone domain where you want to revoke a subscription.

      • id — (String)

        The identifier of the revoked subscription.

      • retainPermissions — (Boolean)

        Specifies whether permissions are retained when the subscription is revoked.

      • status — (String)

        The status of the revoked subscription.

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

        The subscribed listing of the revoked subscription.

        • descriptionrequired — (String)

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

        • idrequired — (String)

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

        • itemrequired — (map)

          The published asset for which the subscription grant is created.

          • assetListing — (map)

            The asset for which the subscription grant is created.

            • assetScope — (map)

              The asset scope of the subscribed asset listing.

              • assetIdrequired — (String)

                The asset ID of the asset scope.

              • errorMessage — (String)

                The error message of the asset scope.

              • filterIdsrequired — (Array<String>)

                The filter IDs of the asset scope.

              • statusrequired — (String)

                The status of the asset scope.

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

          • productListing — (map)

            The data product listing.

            • assetListings — (Array<map>)

              The data assets of the data product listing.

              • entityId — (String)

                The entity ID of the listing of the asset in a data product.

              • entityRevision — (String)

                The entity revision of the listing of the asset in a data product.

              • entityType — (String)

                The entity type of the listing of the asset in a data product.

            • description — (String)

              The description of the data product listing.

            • entityId — (String)

              The ID of the data product listing.

            • entityRevision — (String)

              The revision of the data product listing.

            • glossaryTerms — (Array<map>)

              The glossary terms of the data product listing.

              • 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 — (String)

              The name of the data product listing.

        • namerequired — (String)

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

        • ownerProjectIdrequired — (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 subscribed principal of the revoked subscription.

        • 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 identifier of the subscription request for the revoked subscription.

      • updatedAt — (Date)

        The timestamp of when the subscription was revoked.

      • updatedBy — (String)

        The Amazon DataZone user who revoked the subscription.

Returns:

  • (AWS.Request)

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

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

Searches for assets in Amazon DataZone.

Service Reference:

Examples:

Calling the search operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  searchScope: ASSET | GLOSSARY | GLOSSARY_TERM | DATA_PRODUCT, /* required */
  additionalAttributes: [
    FORMS | TIME_SERIES_DATA_POINT_FORMS,
    /* more items */
  ],
  filters: { /* FilterClause */
    and: [
      /* recursive FilterClause */,
      /* more items */
    ],
    filter: {
      attribute: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    or: [
      /* recursive FilterClause */,
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  owningProjectIdentifier: 'STRING_VALUE',
  searchIn: [
    {
      attribute: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  searchText: 'STRING_VALUE',
  sort: {
    attribute: 'STRING_VALUE', /* required */
    order: ASCENDING | DESCENDING
  }
};
datazone.search(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: {})
    • additionalAttributes — (Array<String>)

      Specifies additional attributes for the Search action.

    • domainIdentifier — (String)

      The identifier of the Amazon DataZone domain.

    • filters — (map)

      Specifies the search filters.

      • and — (Array<map>)

        The 'and' search filter clause in Amazon DataZone.

        • filter — (map)

          A search filter in Amazon DataZone.

          • attributerequired — (String)

            A search filter attribute in Amazon DataZone.

          • valuerequired — (String)

            A search filter value in Amazon DataZone.

      • filter — (map)

        A search filter in Amazon DataZone.

        • attributerequired — (String)

          A search filter attribute in Amazon DataZone.

        • valuerequired — (String)

          A search filter value in Amazon DataZone.

      • or — (Array<map>)

        The 'or' search filter clause in Amazon DataZone.

        • filter — (map)

          A search filter in Amazon DataZone.

          • attributerequired — (String)

            A search filter attribute in Amazon DataZone.

          • valuerequired — (String)

            A search filter value in Amazon DataZone.

    • maxResults — (Integer)

      The maximum number of results to return in a single call to Search. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to Search to list the next set of results.

    • nextToken — (String)

      When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

    • owningProjectIdentifier — (String)

      The identifier of the owning project specified for the search.

    • searchIn — (Array<map>)

      The details of the search.

      • attributerequired — (String)

        The search attribute.

    • searchScope — (String)

      The scope of the search.

      Possible values include:
      • "ASSET"
      • "GLOSSARY"
      • "GLOSSARY_TERM"
      • "DATA_PRODUCT"
    • searchText — (String)

      Specifies the text for which to search.

    • sort — (map)

      Specifies the way in which the search results are to be sorted.

      • attributerequired — (String)

        The attribute detail of the way to sort search results.

      • order — (String)

        The order detail of the wya to sort search results.

        Possible values include:
        • "ASCENDING"
        • "DESCENDING"

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:

      • items — (Array<map>)

        The results of the Search action.

        • assetItem — (map)

          The asset item included in the search results.

          • additionalAttributes — (map)

            The additional attributes of a Amazon DataZone inventory asset.

            • formsOutput — (Array<map>)

              The forms included in the additional attributes of an inventory asset.

              • content — (String)

                The content of the metadata form.

              • formNamerequired — (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.

            • latestTimeSeriesDataPointFormsOutput — (Array<map>)

              The latest time series data points forms included in the additional attributes of an asset.

              • contentSummary — (String)

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

              • formNamerequired — (String)

                The name of the time series data points summary form.

              • id — (String)

                The ID of the time series data points summary form.

              • timestamprequired — (Date)

                The timestamp of the time series data points summary form.

              • typeIdentifierrequired — (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.

            • readOnlyFormsOutput — (Array<map>)

              The read-only forms included in the additional attributes of an inventory asset.

              • content — (String)

                The content of the metadata form.

              • formNamerequired — (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.

          • createdAt — (Date)

            The timestamp of when the Amazon DataZone inventory asset was created.

          • createdBy — (String)

            The Amazon DataZone user who created the inventory asset.

          • description — (String)

            The description of an Amazon DataZone inventory asset.

          • domainIdrequired — (String)

            The identifier of the Amazon DataZone domain in which the inventory asset exists.

          • externalIdentifier — (String)

            The external identifier of the Amazon DataZone inventory asset.

          • firstRevisionCreatedAt — (Date)

            The timestamp of when the first revision of the inventory asset was created.

          • firstRevisionCreatedBy — (String)

            The Amazon DataZone user who created the first revision of the inventory asset.

          • glossaryTerms — (Array<String>)

            The glossary terms attached to the Amazon DataZone inventory asset.

          • identifierrequired — (String)

            the identifier of the Amazon DataZone inventory asset.

          • namerequired — (String)

            The name of the Amazon DataZone inventory asset.

          • owningProjectIdrequired — (String)

            The identifier of the Amazon DataZone project that owns the inventory asset.

          • typeIdentifierrequired — (String)

            The identifier of the asset type of the specified Amazon DataZone inventory asset.

          • typeRevisionrequired — (String)

            The revision of the inventory asset type.

        • dataProductItem — (map)

          The data product.

          • createdAt — (Date)

            The timestamp at which the data product was created.

          • createdBy — (String)

            The user who created the data product.

          • description — (String)

            The description of the data product.

          • domainIdrequired — (String)

            The ID of the domain where the data product lives.

          • firstRevisionCreatedAt — (Date)

            The timestamp at which first revision of the data product was created.

          • firstRevisionCreatedBy — (String)

            The user who created the first revision of the data product.

          • glossaryTerms — (Array<String>)

            The glossary terms of the data product.

          • idrequired — (String)

            The ID of the data product.

          • namerequired — (String)

            The name of the data product.

          • owningProjectIdrequired — (String)

            The ID of the owning project of the data product.

        • glossaryItem — (map)

          The glossary item included in the search results.

          • createdAt — (Date)

            The timestamp of when the glossary was created.

          • createdBy — (String)

            The Amazon DataZone user who created the glossary.

          • description — (String)

            The business glossary description.

          • domainIdrequired — (String)

            The identifier of the Amazon DataZone domain in which the business glossary exists.

          • idrequired — (String)

            The identifier of the glossary.

          • namerequired — (String)

            The name of the glossary.

          • owningProjectIdrequired — (String)

            The identifier of the project that owns the business glosary.

          • statusrequired — (String)

            The business glossary status.

            Possible values include:
            • "DISABLED"
            • "ENABLED"
          • updatedAt — (Date)

            The timestamp of when the business glossary was updated.

          • updatedBy — (String)

            The Amazon DataZone user who updated the business glossary.

        • glossaryTermItem — (map)

          The glossary term item included in the search results.

          • createdAt — (Date)

            The timestamp of when a business glossary term was created.

          • createdBy — (String)

            The Amazon DataZone user who created the business glossary.

          • domainIdrequired — (String)

            The identifier of the Amazon DataZone domain in which the business glossary exists.

          • glossaryIdrequired — (String)

            The identifier of the business glossary to which the term belongs.

          • idrequired — (String)

            The identifier of the business glossary term.

          • longDescription — (String)

            The long description of the business glossary term.

          • namerequired — (String)

            The name of the business glossary term.

          • shortDescription — (String)

            The short description of the business glossary term.

          • statusrequired — (String)

            The status of the business glossary term.

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

            The relations of the business glossary term.

            • classifies — (Array<String>)

              The classifies of the term relations.

            • isA — (Array<String>)

              The isA property of the term relations.

          • updatedAt — (Date)

            The timestamp of when a business glossary term was updated.

          • updatedBy — (String)

            The Amazon DataZone user who updated the business glossary term.

      • nextToken — (String)

        When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to Search to list the next set of results.

      • totalMatchCount — (Integer)

        Total number of search results.

Returns:

  • (AWS.Request)

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

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

Searches group profiles in Amazon DataZone.

Service Reference:

Examples:

Calling the searchGroupProfiles operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  groupType: SSO_GROUP | DATAZONE_SSO_GROUP, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  searchText: 'STRING_VALUE'
};
datazone.searchGroupProfiles(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 identifier of the Amazon DataZone domain in which you want to search group profiles.

    • groupType — (String)

      The group type for which to search.

      Possible values include:
      • "SSO_GROUP"
      • "DATAZONE_SSO_GROUP"
    • maxResults — (Integer)

      The maximum number of results to return in a single call to SearchGroupProfiles. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchGroupProfiles to list the next set of results.

    • nextToken — (String)

      When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.

    • searchText — (String)

      Specifies the text for which to search.

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:

      • items — (Array<map>)

        The results of the SearchGroupProfiles action.

        • domainId — (String)

          The ID of the Amazon DataZone domain of a group profile.

        • groupName — (String)

          The group name of a group profile.

        • id — (String)

          The ID of a group profile.

        • status — (String)

          The status of a group profile.

          Possible values include:
          • "ASSIGNED"
          • "NOT_ASSIGNED"
      • nextToken — (String)

        When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchGroupProfiles to list the next set of results.

Returns:

  • (AWS.Request)

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

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

Searches listings (records of an asset at a given time) in Amazon DataZone.

Service Reference:

Examples:

Calling the searchListings operation

var params = {
  domainIdentifier: 'STRING_VALUE', /* required */
  additionalAttributes: [
    FORMS | TIME_SERIES_DATA_POINT_FORMS,
    /* more items */
  ],
  filters: { /* FilterClause */
    and: [
      /* recursive FilterClause */,
      /* more items */
    ],
    filter: {
      attribute: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    or: [
      /* recursive FilterClause */,
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  searchIn: [
    {
      attribute: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  searchText: 'STRING_VALUE',
  sort: {
    attribute: 'STRING_VALUE', /* required */
    order: ASCENDING | DESCENDING
  }
};
datazone.searchListings(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: {})
    • additionalAttributes — (Array<String>)

      Specifies additional attributes for the search.

    • domainIdentifier — (String)

      The identifier of the domain in which to search listings.

    • filters — (map)

      Specifies the filters for the search of listings.

      • and — (Array<map>)

        The 'and' search filter clause in Amazon DataZone.

        • filter — (map)

          A search filter in Amazon DataZone.

          • attributerequired — (String)

            A search filter attribute in Amazon DataZone.

          • valuerequired — (String)

            A search filter value in Amazon DataZone.

      • filter — (map)

        A search filter in Amazon DataZone.

        • attributerequired — (String)

          A search filter attribute in Amazon DataZone.

        • valuerequired — (String)

          A search filter value in Amazon DataZone.

      • or — (Array<map>)

        The 'or' search filter clause in Amazon DataZone.

        • filter — (map)

          A search filter in Amazon DataZone.

          • attributerequired — (String)

            A search filter attribute in Amazon DataZone.

          • valuerequired — (String)

            A search filter value in Amazon DataZone.

    • maxResults — (Integer)

      The maximum number of results to return in a single call to SearchListings. When the number of results to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to SearchListings to list the next set of results.

    • nextToken — (String)

      When the number of results is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of results, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to SearchListings to list the next set of results.

    • searchIn — (Array<map>)

      The details of the search.

      • attributerequired — (String)

        The search attribute.

    • searchText — (String)

      Specifies the text for which to search.

    • sort — (map)

      Specifies the way for sorting the search results.

      • attributerequired — (String)

        The attribute detail of the way to sort search results.

      • order — (String)

        The order detail of the wya to sort search results.

        Possible values include:
        • "ASCENDING"
        • "DESCENDING"

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:

      • items — (Array<map>)

        The results of the SearchListings action.

        • assetListing — (map)

          The asset listing included in the results of the SearchListings action.

          • additionalAttributes — (map)

            The additional attributes of an asset published in an Amazon DataZone catalog.

            • forms — (String)

              The metadata forms that form additional attributes of the metadata asset.

            • latestTimeSeriesDataPointForms — (Array<map>)

              The latest time series data points forms included in the additional attributes of an asset.

              • contentSummary — (String)

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

              • formNamerequired — (String)

                The name of the time series data points summary form.

              • id — (String)

                The ID of the time series data points summary form.

              • timestamprequired — (Date)

                The timestamp of the time series data points summary form.

              • typeIdentifierrequired — (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.

          • createdAt — (Date)

            The timestamp of when an asset published in an Amazon DataZone catalog was created.

          • description — (String)

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

          • entityId — (String)

            The identifier of the inventory asset.

          • entityRevision — (String)

            The revision of the inventory asset.

          • entityType — (String)

            The type of the inventory asset.

          • glossaryTerms — (Array<map>)

            Glossary terms attached to the inventory asset.

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

          • listingCreatedBy &