создание источника данных

Описание

Создаёт источник данных.

См. также: Документацию API AWS

Синтаксис

  create-data-source
--aws-account-id <value>
--data-source-id <value>
--name <value>
--type <value>
[--data-source-parameters <value>]
[--credentials <value>]
[--permissions <value>]
[--vpc-connection-properties <value>]
[--ssl-properties <value>]
[--tags <value>]
[--folder-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--aws-account-id (строка)

Идентификатор учётной записи Amazon Web Services.

--data-source-id (строка)

Идентификатор источника данных. Этот идентификатор уникален для каждой области Amazon Web Services для каждой учётной записи Amazon Web Services.

--name (строка)

Имя источника данных для отображения.

--type (строка)

Тип источника данных. Для получения списка всех источников данных используйте ListDataSources .

Используйте AMAZON_ELASTICSEARCH для Amazon OpenSearch Service.

Возможные значения:

ADOBE_ANALYTICS
AMAZON_ELASTICSEARCH
ATHENA
AURORA
AURORA_POSTGRESQL
AWS_IOT_ANALYTICS
GITHUB
JIRA
MARIADB
MYSQL
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
S3
SALESFORCE
SERVICENOW
SNOWFLAKE
SPARK
SQLSERVER
TERADATA
TWITTER
TIMESTREAM
AMAZON_OPENSEARCH
EXASOL
DATABRICKS
STARBURST
TRINO
BIGQUERY

--data-source-parameters (структура)

Параметры, которые Amazon QuickSight использует для подключения к вашему исходному источнику.

AmazonElasticsearchParameters -> (структура)

Параметры для OpenSearch.

Domain -> (строка)

Домен OpenSearch.

AthenaParameters -> (структура)

Параметры для Amazon Athena.

WorkGroup -> (строка)

Группа задач, используемая Amazon Athena.

RoleArn -> (строка)

Используйте структуру RoleArn, чтобы переопределить роль на уровне учетной записи для определенного источника данных Athena. Например, предположим, что администратор учетной записи отключил весь доступ к Athena с помощью роли на уровне учетной записи. Затем администратор может использовать RoleArn, чтобы обойти роль на уровне учетной записи и разрешить доступ к Athena для единственного источника данных Athena, указанного в структуре, даже если роль на уровне учетной записи, запрещающая доступ к Athena, по-прежнему активна.

AuroraParameters -> (структура)

Параметры для Amazon Aurora MySQL.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

AuroraPostgreSqlParameters -> (структура)

Параметры для Amazon Aurora.

Host -> (строка)

Хост Amazon Aurora PostgreSQL-совместимый для подключения.

Port -> (целое число)

Порт, на котором работает Amazon Aurora PostgreSQL.

Database -> (строка)

База данных Amazon Aurora PostgreSQL для подключения.

AwsIotAnalyticsParameters -> (структура)

Параметры для IoT Analytics.

DataSetName -> (строка)

Имя набора данных.

JiraParameters -> (структура)

Параметры для Jira.

SiteBaseUrl -> (строка)

Базовый URL-адрес сайта Jira.

MariaDbParameters -> (структура)

Параметры для MariaDB.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

MySqlParameters -> (структура)

Параметры для MySQL.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

OracleParameters -> (структура)

Параметры для Oracle.

Host -> (строка)

Хост Oracle.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

UseServiceName -> (булево)

Булево значение, указывающее, использует ли Database имя службы или SID. Если это значение оставлено пустым, значение по умолчанию — SID. Если это значение установлено в false, значение равно SID.

PostgreSqlParameters -> (структура)

Параметры для PostgreSQL.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

PrestoParameters -> (структура)

Параметры для Presto.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Catalog -> (строка)

Каталог.

RdsParameters -> (структура)

Параметры для Amazon RDS.

InstanceId -> (строка)

Идентификатор экземпляра.

Database -> (строка)

База данных.

RedshiftParameters -> (структура)

Параметры для Amazon Redshift.

Host -> (строка)

Хост. Это поле может быть пустым, если предоставлен ClusterId.

Port -> (целое число)

Порт. Это поле может быть пустым, если предоставлен ClusterId.

Database -> (строка)

База данных.

ClusterId -> (строка)

Идентификатор кластера. Это поле может быть пустым, если предоставлены Host и Port.

IAMParameters -> (структура)

Необязательный параметр, который использует аутентификацию IAM для предоставления Amazon QuickSight доступа к вашему кластеру. Этот параметр можно использовать вместо DataSourceCredentials.

RoleArn -> (строка)

Используйте структуру RoleArn, чтобы разрешить Amazon QuickSight вызывать redshift:GetClusterCredentials на вашем кластере. Вызывающий субъект должен иметь доступ iam:PassRole, чтобы передать роль Amazon QuickSight. Политика доверия роли должна разрешать службе Amazon QuickSight принять роль.

DatabaseUser -> (строка)

Пользователь, чьи разрешения и принадлежность к группам будут использованы Amazon QuickSight для доступа к кластеру. Если этот пользователь уже существует в вашей базе данных, Amazon QuickSight получит те же разрешения, что и пользователь. Если пользователь не существует, установите значение AutoCreateDatabaseUser в True, чтобы создать нового пользователя с разрешениями PUBLIC.

DatabaseGroups -> (список)

Список групп, чьи разрешения будут предоставлены Amazon QuickSight для доступа к кластеру. Эти разрешения объединяются с разрешениями, предоставленными Amazon QuickSight полем DatabaseUser. Если вы выберете включение этого параметра, RoleArn должен предоставить доступ к redshift:JoinGroup.

(строка)

AutoCreateDatabaseUser -> (булево)

Автоматически создает пользователя базы данных. Если ваша база данных не имеет DatabaseUser, установите этот параметр в True. Если нет DatabaseUser, Amazon QuickSight не сможет подключиться к вашему кластеру. RoleArn, который вы используете для этой операции, должен предоставить доступ к redshift:CreateClusterUser для успешного создания пользователя.

IdentityCenterConfiguration -> (структура)

Необязательный параметр, который настраивает аутентификацию IAM Identity Center для предоставления Amazon QuickSight доступа к вашему кластеру.

Этот параметр можно указать только в том случае, если ваша учетная запись Amazon QuickSight настроена с использованием IAM Identity Center.

EnableIdentityPropagation -> (булево)

Булевый параметр, который управляет использованием передачи надежных идентификаторов.

S3Parameters -> (структура)

Параметры для S3.

ManifestFileLocation -> (структура)

Расположение файла манифеста Amazon S3. Это NULL, если файл манифеста был загружен в Amazon QuickSight.

Bucket -> (строка)

Ведро Amazon S3.

Key -> (строка)

Ключ Amazon S3, определяющий объект.

RoleArn -> (строка)

Используйте структуру RoleArn, чтобы переопределить роль на уровне учетной записи для определенного источника данных S3. Например, предположим, что администратор учетной записи отключил весь доступ к S3 с помощью роли на уровне учетной записи. Тогда администратор может использовать RoleArn, чтобы обойти роль на уровне учетной записи и разрешить доступ к S3 для единственного источника данных S3, указанного в структуре, даже если роль на уровне учетной записи, запрещающая доступ к S3, по-прежнему активна.

ServiceNowParameters -> (структура)

Параметры для ServiceNow.

SiteBaseUrl -> (строка)

URL базового сайта.

SnowflakeParameters -> (структура)

Параметры для Snowflake.

Host -> (строка)

Хост.

Database -> (строка)

База данных.

Warehouse -> (строка)

Склад.

AuthenticationType -> (строка)

Тип аутентификации, который вы хотите использовать для подключения. Этот параметр принимает типы аутентификации OAuth и не-OAuth.

DatabaseAccessControlRole -> (строка)

Роль контроля доступа к базе данных.

OAuthParameters -> (структура)

Объект, содержащий информацию, необходимую для создания подключения к источнику данных между учетной записью Amazon QuickSight и Snowflake.

TokenProviderUrl -> (строка)

URL-адрес конечной точки токена поставщика идентификаторов.

OAuthScope -> (строка)

Область OAuth.

IdentityProviderVpcConnectionProperties -> (структура)

Свойства подключения VPC.

VpcConnectionArn -> (строка)

Идентификатор ресурса Amazon (ARN) для подключения VPC.

IdentityProviderResourceUri -> (строка)

URI ресурса поставщика идентификаторов.

SparkParameters -> (структура)

Параметры для Spark.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

SqlServerParameters -> (структура)

Параметры для SQL Server.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

TeradataParameters -> (структура)

Параметры для Teradata.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

TwitterParameters -> (структура)

Параметры для Twitter.

Query -> (строка)

Строка запроса Twitter.

MaxRows -> (целое число)

Максимальное количество строк для запроса Twitter.

AmazonOpenSearchParameters -> (структура)

Параметры для OpenSearch.

Domain -> (строка)

Домен OpenSearch.

ExasolParameters -> (структура)

Параметры для Exasol.

Host -> (строка)

Имя хоста или IP-адрес источника данных Exasol.

Port -> (целое число)

Порт источника данных Exasol.

DatabricksParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Databricks.

Host -> (строка)

Имя хоста источника данных Databricks.

Port -> (целое число)

Порт источника данных Databricks.

SqlEndpointPath -> (строка)

HTTP-путь источника данных Databricks.

StarburstParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Starburst.

Host -> (строка)

Имя хоста источника данных Starburst.

Port -> (целое число)

Порт источника данных Starburst.

Catalog -> (строка)

Имя каталога источника данных Starburst.

ProductType -> (строка)

Тип продукта источника данных Starburst.

DatabaseAccessControlRole -> (строка)

Роль контроля доступа к базе данных.

AuthenticationType -> (строка)

OAuthParameters -> (структура)

Объект, содержащий информацию, необходимую для создания подключения к источнику данных между учетной записью Amazon QuickSight и Starburst.

TokenProviderUrl -> (строка)

URL-адрес конечной точки токена поставщика идентификаторов.

OAuthScope -> (строка)

Область OAuth.

IdentityProviderVpcConnectionProperties -> (структура)

Свойства подключения VPC.

VpcConnectionArn -> (строка)

Идентификатор ресурса Amazon (ARN) для подключения VPC.

IdentityProviderResourceUri -> (строка)

URI ресурса поставщика идентификаторов.

TrinoParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Trino.

Host -> (строка)

Имя хоста источника данных Trino.

Port -> (целое число)

Порт источника данных Trino.

Catalog -> (строка)

Имя каталога источника данных Trino.

BigQueryParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Google BigQuery.

ProjectId -> (строка)

Идентификатор проекта Google Cloud Platform, в котором был создан ваш источник данных.

DataSetRegion -> (строка)

Место хранения, где вы создали источник данных Google BigQuery.

Синтаксис JSON:

{
  "AmazonElasticsearchParameters": {
    "Domain": "string"
  },
  "AthenaParameters": {
    "WorkGroup": "string",
    "RoleArn": "string"
  },
  "AuroraParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "AuroraPostgreSqlParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "AwsIotAnalyticsParameters": {
    "DataSetName": "string"
  },
  "JiraParameters": {
    "SiteBaseUrl": "string"
  },
  "MariaDbParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "MySqlParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "OracleParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string",
    "UseServiceName": true|false
  },
  "PostgreSqlParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "PrestoParameters": {
    "Host": "string",
    "Port": integer,
    "Catalog": "string"
  },
  "RdsParameters": {
    "InstanceId": "string",
    "Database": "string"
  },
  "RedshiftParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string",
    "ClusterId": "string",
    "IAMParameters": {
      "RoleArn": "string",
      "DatabaseUser": "string",
      "DatabaseGroups": ["string", ...],
      "AutoCreateDatabaseUser": true|false
    },
    "IdentityCenterConfiguration": {
      "EnableIdentityPropagation": true|false
    }
  },
  "S3Parameters": {
    "ManifestFileLocation": {
      "Bucket": "string",
      "Key": "string"
    },
    "RoleArn": "string"
  },
  "ServiceNowParameters": {
    "SiteBaseUrl": "string"
  },
  "SnowflakeParameters": {
    "Host": "string",
    "Database": "string",
    "Warehouse": "string",
    "AuthenticationType": "PASSWORD"|"TOKEN"|"X509",
    "DatabaseAccessControlRole": "string",
    "OAuthParameters": {
      "TokenProviderUrl": "string",
      "OAuthScope": "string",
      "IdentityProviderVpcConnectionProperties": {
        "VpcConnectionArn": "string"
      },
      "IdentityProviderResourceUri": "string"
    }
  },
  "SparkParameters": {
    "Host": "string",
    "Port": integer
  },
  "SqlServerParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "TeradataParameters": {
    "Host": "string",
    "Port": integer,
    "Database": "string"
  },
  "TwitterParameters": {
    "Query": "string",
    "MaxRows": integer
  },
  "AmazonOpenSearchParameters": {
    "Domain": "string"
  },
  "ExasolParameters": {
    "Host": "string",
    "Port": integer
  },
  "DatabricksParameters": {
    "Host": "string",
    "Port": integer,
    "SqlEndpointPath": "string"
  },
  "StarburstParameters": {
    "Host": "string",
    "Port": integer,
    "Catalog": "string",
    "ProductType": "GALAXY"|"ENTERPRISE",
    "DatabaseAccessControlRole": "string",
    "AuthenticationType": "PASSWORD"|"TOKEN"|"X509",
    "OAuthParameters": {
      "TokenProviderUrl": "string",
      "OAuthScope": "string",
      "IdentityProviderVpcConnectionProperties": {
        "VpcConnectionArn": "string"
      },
      "IdentityProviderResourceUri": "string"
    }
  },
  "TrinoParameters": {
    "Host": "string",
    "Port": integer,
    "Catalog": "string"
  },
  "BigQueryParameters": {
    "ProjectId": "string",
    "DataSetRegion": "string"
  }
}

--credentials (структура)

Укажите учетные данные Amazon QuickSight, используемые для подключения к вашему исходному источнику данных. В настоящее время поддерживаются только учетные данные, основанные на имени пользователя и пароле.

CredentialPair -> (структура)

Пара учетных данных. Для получения дополнительной информации см. `` CredentialPair ``.

Username -> (строка)

Имя пользователя.

Password -> (строка)

Пароль.

AlternateDataSourceParameters -> (список)

Набор альтернативных параметров источника данных, которые вы хотите использовать для этих учетных данных. Учетные данные применяются совместно с параметрами источника данных при копировании источника данных с помощью запроса create или update. API-операция сравнивает структуру DataSourceParameters в запросе со структурами в списке разрешений AlternateDataSourceParameters. Если структуры полностью совпадают, запрос разрешается использовать новый источник данных с существующими учетными данными. Если список AlternateDataSourceParameters пустой, то список DataSourceParameters, изначально использованный с этими Credentials, автоматически разрешается.

(структура)

Параметры, используемые Amazon QuickSight для подключения к вашему исходному источнику данных. Это структура типа «вариант». Для того, чтобы эта структура была корректной, только одно из свойств может быть не null.

AmazonElasticsearchParameters -> (структура)

Параметры для OpenSearch.

Domain -> (строка)

Домен OpenSearch.

AthenaParameters -> (структура)

Параметры для Amazon Athena.

WorkGroup -> (строка)

Группа задач, используемая Amazon Athena.

RoleArn -> (строка)

Используйте структуру RoleArn, чтобы переопределить роль уровня учетной записи для конкретного источника данных Athena. Например, предположим, что администратор учетной записи отключил весь доступ к Athena с помощью роли уровня учетной записи. Тогда администратор может использовать RoleArn, чтобы обойти роль уровня учетной записи и разрешить доступ к Athena для отдельного источника данных Athena, указанного в структуре, даже если роль уровня учетной записи, запрещающая доступ к Athena, по-прежнему активна.

AuroraParameters -> (структура)

Параметры для Amazon Aurora MySQL.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

AuroraPostgreSqlParameters -> (структура)

Параметры для Amazon Aurora.

Host -> (строка)

Хост Amazon Aurora PostgreSQL для подключения.

Port -> (целое число)

Порт, на котором слушает Amazon Aurora PostgreSQL.

Database -> (строка)

База данных Amazon Aurora PostgreSQL для подключения.

AwsIotAnalyticsParameters -> (структура)

Параметры для IoT Analytics.

DataSetName -> (строка)

Название набора данных.

JiraParameters -> (структура)

Параметры для Jira.

SiteBaseUrl -> (строка)

Базовый URL-адрес сайта Jira.

MariaDbParameters -> (структура)

Параметры для MariaDB.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

MySqlParameters -> (структура)

Параметры для MySQL.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

OracleParameters -> (структура)

Параметры для Oracle.

Host -> (строка)

Хост Oracle.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

UseServiceName -> (булево)

Булево значение, указывающее, использует ли Database имя службы или SID. Если это значение не указано, по умолчанию используется SID. Если это значение установлено в false, значение равно SID.

PostgreSqlParameters -> (структура)

Параметры для PostgreSQL.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

PrestoParameters -> (структура)

Параметры для Presto.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Catalog -> (строка)

Каталог.

RdsParameters -> (структура)

Параметры для Amazon RDS.

InstanceId -> (строка)

Идентификатор экземпляра.

Database -> (строка)

База данных.

RedshiftParameters -> (структура)

Параметры для Amazon Redshift.

Host -> (строка)

Хост. Это поле может быть пустым, если указан ClusterId.

Port -> (целое число)

Порт. Это поле может быть пустым, если указан ClusterId.

Database -> (строка)

База данных.

ClusterId -> (строка)

Идентификатор кластера. Это поле может быть пустым, если указаны Host и Port.

IAMParameters -> (структура)

Необязательный параметр, использующий аутентификацию IAM для предоставления Amazon QuickSight доступа к кластеру. Этот параметр может быть использован вместо DataSourceCredentials.

RoleArn -> (строка)

Используйте структуру RoleArn, чтобы разрешить Amazon QuickSight вызывать redshift:GetClusterCredentials на вашем кластере. Вызывающий субъект должен иметь iam:PassRole доступ для передачи роли Amazon QuickSight. Политика доверия роли должна разрешать службе Amazon QuickSight принять роль.

DatabaseUser -> (строка)

Пользователь, чьи разрешения и группы будут использоваться Amazon QuickSight для доступа к кластеру. Если этот пользователь уже существует в вашей базе данных, Amazon QuickSight получает те же разрешения, что и у пользователя. Если пользователь не существует, установите значение AutoCreateDatabaseUser в True, чтобы создать нового пользователя с разрешениями PUBLIC.

DatabaseGroups -> (список)

Список групп, чьи разрешения будут предоставлены Amazon QuickSight для доступа к кластеру. Эти разрешения комбинируются с разрешениями, предоставленными Amazon QuickSight DatabaseUser. Если вы решили включить этот параметр, RoleArn должен предоставить доступ к redshift:JoinGroup.

(строка)

AutoCreateDatabaseUser -> (булево)

Автоматически создаёт пользователя базы данных. Если в вашей базе данных нет DatabaseUser, установите этот параметр в значение True. Если DatabaseUser отсутствует, Amazon QuickSight не сможет подключиться к вашему кластеру. RoleArn, который вы используете для этой операции, должен предоставить доступ к redshift:CreateClusterUser для успешного создания пользователя.

IdentityCenterConfiguration -> (структура)

Необязательный параметр, который настраивает аутентификацию IAM Identity Center для предоставления Amazon QuickSight доступа к кластеру.

Этот параметр может быть указан только в том случае, если ваша учетная запись Amazon QuickSight настроена с IAM Identity Center.

EnableIdentityPropagation -> (булево)

Булевое значение, которое управляет тем, будет ли использоваться Trusted Identity Propagation.

S3Parameters -> (структура)

Параметры для S3.

ManifestFileLocation -> (структура)

Расположение файла манифеста Amazon S3. Это NULL, если файл манифеста был загружен в Amazon QuickSight.

Bucket -> (строка)

Ведро Amazon S3.

Key -> (строка)

Ключ Amazon S3, идентифицирующий объект.

RoleArn -> (строка)

Используйте структуру RoleArn, чтобы переопределить роль уровня учетной записи для конкретного источника данных S3. Например, предположим, что администратор учетной записи отключил весь доступ к S3 с помощью роли уровня учетной записи. Тогда администратор может использовать RoleArn, чтобы обойти роль уровня учетной записи и разрешить доступ к S3 для отдельного источника данных S3, указанного в структуре, даже если роль уровня учетной записи, запрещающая доступ к S3, по-прежнему активна.

ServiceNowParameters -> (структура)

Параметры для ServiceNow.

SiteBaseUrl -> (строка)

URL базового сайта.

SnowflakeParameters -> (структура)

Параметры для Snowflake.

Host -> (строка)

Хост.

Database -> (строка)

База данных.

Warehouse -> (строка)

Склад.

AuthenticationType -> (строка)

DatabaseAccessControlRole -> (строка)

Роль доступа к базе данных.

OAuthParameters -> (структура)

TokenProviderUrl -> (строка)

URL конечной точки поставщика токенов.

OAuthScope -> (строка)

Диапазон OAuth.

IdentityProviderVpcConnectionProperties -> (структура)

Свойства подключения VPC.

VpcConnectionArn -> (строка)

Amazon Resource Name (ARN) для подключения VPC.

IdentityProviderResourceUri -> (строка)

URI ресурса поставщика идентификаторов.

SparkParameters -> (структура)

Параметры для Spark.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

SqlServerParameters -> (структура)

Параметры для SQL Server.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

TeradataParameters -> (структура)

Параметры для Teradata.

Host -> (строка)

Хост.

Port -> (целое число)

Порт.

Database -> (строка)

База данных.

TwitterParameters -> (структура)

Параметры для Twitter.

Query -> (строка)

Строка запроса Twitter.

MaxRows -> (целое число)

Максимальное количество строк для запроса в Twitter.

AmazonOpenSearchParameters -> (структура)

Параметры для OpenSearch.

Domain -> (строка)

Домен OpenSearch.

ExasolParameters -> (структура)

Параметры для Exasol.

Host -> (строка)

Имя хоста или IP-адрес источника данных Exasol.

Port -> (целое число)

Порт источника данных Exasol.

DatabricksParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Databricks.

Host -> (строка)

Имя хоста источника данных Databricks.

Port -> (целое число)

Порт источника данных Databricks.

SqlEndpointPath -> (строка)

HTTP-путь источника данных Databricks.

StarburstParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Starburst.

Host -> (строка)

Имя хоста источника данных Starburst.

Port -> (целое число)

Порт источника данных Starburst.

Catalog -> (строка)

Имя каталога источника данных Starburst.

ProductType -> (строка)

Тип продукта источника данных Starburst.

DatabaseAccessControlRole -> (строка)

Роль доступа к базе данных.

AuthenticationType -> (строка)

Тип аутентификации для подключения. Этот параметр принимает типы аутентификации OAuth и не-OAuth.

OAuthParameters -> (структура)

TokenProviderUrl -> (строка)

URL конечной точки получения токенов поставщика идентификации.

OAuthScope -> (строка)

Область OAuth.

IdentityProviderVpcConnectionProperties -> (структура)

Свойства подключения VPC.

VpcConnectionArn -> (строка)

Идентификатор ресурса Amazon (ARN) подключения VPC.

IdentityProviderResourceUri -> (строка)

URI ресурса поставщика идентификации.

TrinoParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Trino.

Host -> (строка)

Имя хоста источника данных Trino.

Port -> (целое число)

Порт источника данных Trino.

Catalog -> (строка)

Имя каталога источника данных Trino.

BigQueryParameters -> (структура)

Параметры, необходимые для подключения к источнику данных Google BigQuery.

ProjectId -> (строка)

Идентификатор проекта Google Cloud Platform, где был создан источник данных.

DataSetRegion -> (строка)

Место хранения, где создается источник данных Google BigQuery.

CopySourceArn -> (строка)

Идентификатор ресурса Amazon (ARN) источника данных, имеющего пару учетных данных, которую вы хотите использовать. Когда CopySourceArn не равно null, пара учетных данных из источника данных в ARN используется в качестве учетных данных для структуры DataSourceCredentials.

SecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета, связанного с источником данных в Amazon Secrets Manager.

Синтаксис JSON:

{
  "CredentialPair": {
    "Username": "string",
    "Password": "string",
    "AlternateDataSourceParameters": [
      {
        "AmazonElasticsearchParameters": {
          "Domain": "string"
        },
        "AthenaParameters": {
          "WorkGroup": "string",
          "RoleArn": "string"
        },
        "AuroraParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "AuroraPostgreSqlParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "AwsIotAnalyticsParameters": {
          "DataSetName": "string"
        },
        "JiraParameters": {
          "SiteBaseUrl": "string"
        },
        "MariaDbParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "MySqlParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "OracleParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string",
          "UseServiceName": true|false
        },
        "PostgreSqlParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "PrestoParameters": {
          "Host": "string",
          "Port": integer,
          "Catalog": "string"
        },
        "RdsParameters": {
          "InstanceId": "string",
          "Database": "string"
        },
        "RedshiftParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string",
          "ClusterId": "string",
          "IAMParameters": {
            "RoleArn": "string",
            "DatabaseUser": "string",
            "DatabaseGroups": ["string", ...],
            "AutoCreateDatabaseUser": true|false
          },
          "IdentityCenterConfiguration": {
            "EnableIdentityPropagation": true|false
          }
        },
        "S3Parameters": {
          "ManifestFileLocation": {
            "Bucket": "string",
            "Key": "string"
          },
          "RoleArn": "string"
        },
        "ServiceNowParameters": {
          "SiteBaseUrl": "string"
        },
        "SnowflakeParameters": {
          "Host": "string",
          "Database": "string",
          "Warehouse": "string",
          "AuthenticationType": "PASSWORD"|"TOKEN"|"X509",
          "DatabaseAccessControlRole": "string",
          "OAuthParameters": {
            "TokenProviderUrl": "string",
            "OAuthScope": "string",
            "IdentityProviderVpcConnectionProperties": {
              "VpcConnectionArn": "string"
            },
            "IdentityProviderResourceUri": "string"
          }
        },
        "SparkParameters": {
          "Host": "string",
          "Port": integer
        },
        "SqlServerParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "TeradataParameters": {
          "Host": "string",
          "Port": integer,
          "Database": "string"
        },
        "TwitterParameters": {
          "Query": "string",
          "MaxRows": integer
        },
        "AmazonOpenSearchParameters": {
          "Domain": "string"
        },
        "ExasolParameters": {
          "Host": "string",
          "Port": integer
        },
        "DatabricksParameters": {
          "Host": "string",
          "Port": integer,
          "SqlEndpointPath": "string"
        },
        "StarburstParameters": {
          "Host": "string",
          "Port": integer,
          "Catalog": "string",
          "ProductType": "GALAXY"|"ENTERPRISE",
          "DatabaseAccessControlRole": "string",
          "AuthenticationType": "PASSWORD"|"TOKEN"|"X509",
          "OAuthParameters": {
            "TokenProviderUrl": "string",
            "OAuthScope": "string",
            "IdentityProviderVpcConnectionProperties": {
              "VpcConnectionArn": "string"
            },
            "IdentityProviderResourceUri": "string"
          }
        },
        "TrinoParameters": {
          "Host": "string",
          "Port": integer,
          "Catalog": "string"
        },
        "BigQueryParameters": {
          "ProjectId": "string",
          "DataSetRegion": "string"
        }
      }
      ...
    ]
  },
  "CopySourceArn": "string",
  "SecretArn": "string"
}

--permissions (список)

Список разрешений на ресурсы источника данных.

(структура)

Разрешение для ресурса.

Principal -> (строка)

Идентификатор ресурса Amazon (ARN) принципала. Это может быть одно из следующего:

ARN пользователя или группы Amazon QuickSight, связанной с источником данных или набором данных. (Это часто используется.)
ARN пользователя, группы или пространства имен Amazon QuickSight, связанных с анализом, панелью мониторинга, шаблоном или темой. (Это часто используется.)
ARN корневого аккаунта Amazon Web Services: Это IAM ARN, а не ARN QuickSight. Используйте этот вариант только для совместного использования ресурсов (шаблонов) между учетными записями Amazon Web Services. (Это менее распространено.)

Actions -> (список)

Действие IAM для предоставления или отзыва разрешений.

(строка)

Краткая форма синтаксиса:

Principal=string,Actions=string,string ...

Синтаксис JSON:

[
  {
    "Principal": "string",
    "Actions": ["string", ...]
  }
  ...
]

--vpc-connection-properties (структура)

Используйте этот параметр только в случае, если вы хотите, чтобы Amazon QuickSight использовал подключение VPC при подключении к вашему исходному источнику.

VpcConnectionArn -> (строка)

Идентификатор ресурса Amazon (ARN) подключения VPC.

Краткая форма синтаксиса:

VpcConnectionArn=string

Синтаксис JSON:

{
  "VpcConnectionArn": "string"
}

--ssl-properties (структура)

Свойства Secure Socket Layer (SSL), применяемые при подключении Amazon QuickSight к вашему исходному источнику.

DisableSsl -> (булево)

Булевый параметр для управления отключением SSL.

Краткая форма синтаксиса:

DisableSsl=boolean

Синтаксис JSON:

{
  "DisableSsl": true|false
}

--tags (список)

Содержит карту пар ключ-значение для тегов ресурса или тегов, назначенных источнику данных.

(структура)

Ключ или ключи пар ключ-значение для тега ресурса или тегов, назначенных ресурсу.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

Краткая форма синтаксиса:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--folder-arns (список)

При создании источника данных Amazon QuickSight добавляет источник данных в эти папки.

(строка)

Синтаксис:

"string" "string" ...

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если не указано значение или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано значение yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, это проверит входные данные команд и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в генерируемом JSON-скелете.

Общие параметры

--debug (булево)

Включить отладочный вывод.

--endpoint-url (строка)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

включить
выключить
авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент указан.

--ca-bundle (строка)

Набор сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и использовать содержимое файла непосредственно, независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (булево)

Отключить вывод пейджера CLI.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров входных данных CLI.

Вывод

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) источника данных.

DataSourceId -> (строка)

Идентификатор источника данных. Этот идентификатор уникален в каждом регионе Amazon Web Services для каждой учетной записи Amazon Web Services.

CreationStatus -> (строка)

Статус создания источника данных.

RequestId -> (строка)

Идентификатор запроса Amazon Web Services для этой операции.

Status -> (целое число)

HTTP-статус запроса.