Skip to content

Creates an Amazon DataZone data source

Description

Creates an Amazon DataZone data source.

Usage

datazone_create_data_source(name, description, domainIdentifier,
  projectIdentifier, environmentIdentifier, connectionIdentifier, type,
  configuration, recommendation, enableSetting, schedule, publishOnImport,
  assetFormsInput, clientToken)

Arguments

  • name

    [required] The name of the data source.

  • description

    The description of the data source.

  • domainIdentifier

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

  • projectIdentifier

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

  • environmentIdentifier

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

  • connectionIdentifier

    The ID of the connection.

  • type

    [required] The type of the data source. In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for Amazon Web Services Glue and Amazon Redshift.

  • configuration

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

  • recommendation

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

  • enableSetting

    Specifies whether the data source is enabled.

  • schedule

    The schedule of the data source runs.

  • publishOnImport

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

  • assetFormsInput

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

  • clientToken

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

Value

A list with the following syntax:

list(
  id = "string",
  status = "CREATING"|"FAILED_CREATION"|"READY"|"UPDATING"|"FAILED_UPDATE"|"RUNNING"|"DELETING"|"FAILED_DELETION",
  type = "string",
  name = "string",
  description = "string",
  domainId = "string",
  projectId = "string",
  environmentId = "string",
  connectionId = "string",
  configuration = list(
    glueRunConfiguration = list(
      accountId = "string",
      region = "string",
      dataAccessRole = "string",
      relationalFilterConfigurations = list(
        list(
          databaseName = "string",
          schemaName = "string",
          filterExpressions = list(
            list(
              type = "INCLUDE"|"EXCLUDE",
              expression = "string"
            )
          )
        )
      ),
      autoImportDataQualityResult = TRUE|FALSE,
      catalogName = "string"
    ),
    redshiftRunConfiguration = list(
      accountId = "string",
      region = "string",
      dataAccessRole = "string",
      relationalFilterConfigurations = list(
        list(
          databaseName = "string",
          schemaName = "string",
          filterExpressions = list(
            list(
              type = "INCLUDE"|"EXCLUDE",
              expression = "string"
            )
          )
        )
      ),
      redshiftCredentialConfiguration = list(
        secretManagerArn = "string"
      ),
      redshiftStorage = list(
        redshiftClusterSource = list(
          clusterName = "string"
        ),
        redshiftServerlessSource = list(
          workgroupName = "string"
        )
      )
    ),
    sageMakerRunConfiguration = list(
      accountId = "string",
      region = "string",
      trackingAssets = list(
        list(
          "string"
        )
      )
    )
  ),
  recommendation = list(
    enableBusinessNameGeneration = TRUE|FALSE
  ),
  enableSetting = "ENABLED"|"DISABLED",
  publishOnImport = TRUE|FALSE,
  assetFormsOutput = list(
    list(
      formName = "string",
      typeName = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  schedule = list(
    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",
    schedule = "string"
  ),
  lastRunStatus = "REQUESTED"|"RUNNING"|"FAILED"|"PARTIALLY_SUCCEEDED"|"SUCCESS",
  lastRunAt = as.POSIXct(
    "2015-01-01"
  ),
  lastRunErrorMessage = list(
    errorType = "ACCESS_DENIED_EXCEPTION"|"CONFLICT_EXCEPTION"|"INTERNAL_SERVER_EXCEPTION"|"RESOURCE_NOT_FOUND_EXCEPTION"|"SERVICE_QUOTA_EXCEEDED_EXCEPTION"|"THROTTLING_EXCEPTION"|"VALIDATION_EXCEPTION",
    errorDetail = "string"
  ),
  errorMessage = list(
    errorType = "ACCESS_DENIED_EXCEPTION"|"CONFLICT_EXCEPTION"|"INTERNAL_SERVER_EXCEPTION"|"RESOURCE_NOT_FOUND_EXCEPTION"|"SERVICE_QUOTA_EXCEEDED_EXCEPTION"|"THROTTLING_EXCEPTION"|"VALIDATION_EXCEPTION",
    errorDetail = "string"
  ),
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$create_data_source(
  name = "string",
  description = "string",
  domainIdentifier = "string",
  projectIdentifier = "string",
  environmentIdentifier = "string",
  connectionIdentifier = "string",
  type = "string",
  configuration = list(
    glueRunConfiguration = list(
      dataAccessRole = "string",
      relationalFilterConfigurations = list(
        list(
          databaseName = "string",
          schemaName = "string",
          filterExpressions = list(
            list(
              type = "INCLUDE"|"EXCLUDE",
              expression = "string"
            )
          )
        )
      ),
      autoImportDataQualityResult = TRUE|FALSE,
      catalogName = "string"
    ),
    redshiftRunConfiguration = list(
      dataAccessRole = "string",
      relationalFilterConfigurations = list(
        list(
          databaseName = "string",
          schemaName = "string",
          filterExpressions = list(
            list(
              type = "INCLUDE"|"EXCLUDE",
              expression = "string"
            )
          )
        )
      ),
      redshiftCredentialConfiguration = list(
        secretManagerArn = "string"
      ),
      redshiftStorage = list(
        redshiftClusterSource = list(
          clusterName = "string"
        ),
        redshiftServerlessSource = list(
          workgroupName = "string"
        )
      )
    ),
    sageMakerRunConfiguration = list(
      trackingAssets = list(
        list(
          "string"
        )
      )
    )
  ),
  recommendation = list(
    enableBusinessNameGeneration = TRUE|FALSE
  ),
  enableSetting = "ENABLED"|"DISABLED",
  schedule = list(
    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",
    schedule = "string"
  ),
  publishOnImport = TRUE|FALSE,
  assetFormsInput = list(
    list(
      formName = "string",
      typeIdentifier = "string",
      typeRevision = "string",
      content = "string"
    )
  ),
  clientToken = "string"
)