Skip to content

Create Data Source

datazone_create_data_source R Documentation

Creates an Amazon DataZone data source

Description

Creates an Amazon DataZone data source.

Usage

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

Arguments

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.

configuration

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

description

The description of the data source.

domainIdentifier

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

enableSetting

Specifies whether the data source is enabled.

environmentIdentifier

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

name

[required] The name of the data source.

projectIdentifier

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

publishOnImport

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

recommendation

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

schedule

The schedule of the data source runs.

type

[required] The type of the data source.

Value

A list with the following syntax:

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

Request syntax

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