[ aws . quicksight ]
describe-data-source
Описание
Описывает источник данных.
См. также: Документация API AWS
Синтаксис
describe-data-source
--aws-account-id <value>
--data-source-id <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 (строка)
--data-source-id (строка)
--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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 -> (строка)
DataSourceId -> (строка)
Название -> (строка)
Тип -> (строка)
Статус -> (строка)
CreatedTime -> (метка времени)
LastUpdatedTime -> (метка времени)
DataSourceParameters -> (структура)
Параметры, которые Amazon QuickSight использует для подключения к вашему исходному источнику. Это структура переменного типа. Для того, чтобы эта структура была валидной, только один из атрибутов может быть не null.
AmazonElasticsearchParameters -> (структура)
Параметры для OpenSearch.
Домен -> (строка)
AthenaParameters -> (структура)
Параметры для Amazon Athena.
Группа задач -> (строка)
RoleArn -> (строка)
RoleArn, чтобы переопределить роль учетной записи для определенного источника данных Athena. Например, предположим, что администратор учетной записи отключил весь доступ к Athena с помощью роли учетной записи. Затем администратор может использовать RoleArn, чтобы обойти роль учетной записи и разрешить доступ к Athena для единственного источника данных Athena, указанного в структуре, даже если роль учетной записи, запрещающая доступ к Athena, по-прежнему активна.AuroraParameters -> (структура)
Параметры для Amazon Aurora MySQL.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
AuroraPostgreSqlParameters -> (структура)
Параметры для Amazon Aurora.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
AwsIotAnalyticsParameters -> (структура)
Параметры для IoT Analytics.
Имя набора данных -> (строка)
JiraParameters -> (структура)
Параметры для Jira.
Базовый URL сайта -> (строка)
MariaDbParameters -> (структура)
Параметры для MariaDB.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
MySqlParameters -> (структура)
Параметры для MySQL.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
OracleParameters -> (структура)
Параметры для Oracle.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
Использовать имя службы -> (булево)
Database имя службы или SID. Если это значение оставлено пустым, значение по умолчанию равно SID. Если это значение установлено в false, значение равно SID.PostgreSqlParameters -> (структура)
Параметры для PostgreSQL.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
PrestoParameters -> (структура)
Параметры для Presto.
Хост -> (строка)
Порт -> (целое число)
Каталог -> (строка)
RdsParameters -> (структура)
Параметры для Amazon RDS.
Идентификатор экземпляра -> (строка)
База данных -> (строка)
RedshiftParameters -> (структура)
Параметры для Amazon Redshift.
Хост -> (строка)
ClusterId предоставлено.Порт -> (целое число)
ClusterId предоставлено.База данных -> (строка)
Идентификатор кластера -> (строка)
Host и Port предоставлены.IAMParameters -> (структура)
Дополнительный параметр, использующий аутентификацию IAM, чтобы предоставить Amazon QuickSight доступ к вашему кластеру. Этот параметр может быть использован вместо DataSourceCredentials.
RoleArn -> (строка)
RoleArn, чтобы разрешить Amazon QuickSight вызывать redshift:GetClusterCredentials на вашем кластере. Вызывающий субъект должен иметь доступ iam:PassRole для передачи роли 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.
Вёдро -> (строка)
Ключ -> (строка)
RoleArn -> (строка)
RoleArn, чтобы переопределить роль учетной записи для определенного источника данных S3. Например, предположим, что администратор учетной записи отключил весь доступ к S3 с помощью роли учетной записи. Затем администратор может использовать RoleArn, чтобы обойти роль учетной записи и разрешить доступ к S3 для единственного источника данных S3, указанного в структуре, даже если роль учетной записи, запрещающая доступ к S3, по-прежнему активна.ServiceNowParameters -> (структура)
Параметры для ServiceNow.
Базовый URL сайта -> (строка)
SnowflakeParameters -> (структура)
Параметры для Snowflake.
Хост -> (строка)
База данных -> (строка)
Хранилище -> (строка)
Тип аутентификации -> (строка)
Роль доступа к базе данных -> (строка)
OAuthParameters -> (структура)
Объект, содержащий информацию, необходимую для создания подключения к источнику данных между учетной записью Amazon QuickSight и Snowflake.
URL поставщика токенов -> (строка)
Охват OAuth -> (строка)
Свойства подключения к VPC поставщика удостоверений -> (структура)
Свойства подключения к VPC.
VpcConnectionArn -> (строка)
IdentityProviderResourceUri -> (строка)
SparkParameters -> (структура)
Параметры для Spark.
Хост -> (строка)
Порт -> (целое число)
SqlServerParameters -> (структура)
Параметры для SQL Server.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
TeradataParameters -> (структура)
Параметры для Teradata.
Хост -> (строка)
Порт -> (целое число)
База данных -> (строка)
TwitterParameters -> (структура)
Параметры для Twitter.
Строка запроса -> (строка)
Максимальное количество строк -> (целое число)
AmazonOpenSearchParameters -> (структура)
Параметры для OpenSearch.
Домен -> (строка)
ExasolParameters -> (структура)
Параметры для Exasol.
Хост -> (строка)
Порт -> (целое число)
DatabricksParameters -> (структура)
Параметры, необходимые для подключения к источнику данных Databricks.
Хост -> (строка)
Порт -> (целое число)
SqlEndpointPath -> (строка)
StarburstParameters -> (структура)
Параметры, необходимые для подключения к источнику данных Starburst.
Host -> (строка)
Port -> (целое число)
Catalog -> (строка)
ProductType -> (строка)
DatabaseAccessControlRole -> (строка)
AuthenticationType -> (строка)
OAuthParameters -> (структура)
Объект, содержащий информацию, необходимую для создания подключения к источнику данных между учётной записью Amazon QuickSight и Starburst.
TokenProviderUrl -> (строка)
OAuthScope -> (строка)
IdentityProviderVpcConnectionProperties -> (структура)
Свойства подключения VPC.
VpcConnectionArn -> (строка)
IdentityProviderResourceUri -> (строка)
TrinoParameters -> (структура)
Параметры, необходимые для подключения к источнику данных Trino.
Host -> (строка)
Port -> (целое число)
Catalog -> (строка)
BigQueryParameters -> (структура)
Параметры, необходимые для подключения к источнику данных Google BigQuery.
ProjectId -> (строка)
DataSetRegion -> (строка)
AlternateDataSourceParameters -> (список)
Набор альтернативных параметров источника данных, которые вы хотите использовать для учетных данных, хранящихся с этим источником данных. Учетные данные применяются совместно с параметрами источника данных при копировании источника данных с помощью запроса создания или обновления. Операция API сравнивает структуру DataSourceParameters в запросе со структурами в списке разрешенных структур AlternateDataSourceParameters. Если структуры точно совпадают, запрос получает разрешение использовать учетные данные из этого существующего источника данных. Если список AlternateDataSourceParameters равен null, учетные данные, которые использовались первоначально с этим DataSourceParameters, автоматически разрешаются.
(структура)
Параметры, которые Amazon QuickSight использует для подключения к вашему исходному источнику данных. Это структура типа «variant». Для того, чтобы эта структура была действительной, только один из атрибутов может быть не нулевым.
AmazonElasticsearchParameters -> (структура)
Параметры для OpenSearch.
Domain -> (строка)
AthenaParameters -> (структура)
Параметры для Amazon Athena.
WorkGroup -> (строка)
RoleArn -> (строка)
RoleArn для переопределения роли на уровне учетной записи для конкретного источника данных Athena. Например, предположим, что администратор учетной записи отключил весь доступ Athena с помощью роли на уровне учетной записи. Затем администратор может использовать RoleArn, чтобы обойти роль на уровне учетной записи и разрешить доступ Athena для отдельного источника данных Athena, указанного в структуре, даже если роль на уровне учетной записи, запрещающая доступ Athena, по-прежнему активна.AuroraParameters -> (структура)
Параметры для Amazon Aurora MySQL.
Host -> (строка)
Port -> (целое число)
Database -> (строка)
AuroraPostgreSqlParameters -> (структура)
Параметры для Amazon Aurora.
Host -> (строка)
Port -> (целое число)
Database -> (строка)
AwsIotAnalyticsParameters -> (структура)
Параметры для IoT Analytics.
DataSetName -> (строка)
JiraParameters -> (структура)
Параметры для Jira.
SiteBaseUrl -> (строка)
MariaDbParameters -> (структура)
Параметры для MariaDB.
Host -> (строка)
Port -> (целое число)
Database -> (строка)
MySqlParameters -> (структура)
Параметры для MySQL.
Host -> (строка)
Port -> (целое число)
Database -> (строка)
OracleParameters -> (структура)
Параметры для Oracle.
Host -> (строка)
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 -> (строка)
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 -> (строка)
Key -> (строка)
RoleArn -> (строка)
RoleArn для переопределения роли на уровне учетной записи для конкретного источника данных S3. Например, предположим, что администратор учетной записи отключил весь доступ S3 с помощью роли на уровне учетной записи. Тогда администратор может использовать RoleArn, чтобы обойти роль на уровне учетной записи и разрешить доступ S3 для отдельного источника данных S3, указанного в структуре, даже если роль на уровне учетной записи, запрещающая доступ S3, по-прежнему активна.ServiceNowParameters -> (структура)
Параметры для ServiceNow.
SiteBaseUrl -> (строка)
SnowflakeParameters -> (структура)
Параметры для Snowflake.
Host -> (строка)
Database -> (строка)
Warehouse -> (строка)
AuthenticationType -> (строка)
DatabaseAccessControlRole -> (строка)
OAuthParameters -> (структура)
Объект, содержащий информацию, необходимую для создания подключения к источнику данных между учетной записью Amazon QuickSight и Snowflake.
TokenProviderUrl -> (строка)
OAuthScope -> (строка)
IdentityProviderVpcConnectionProperties -> (структура)
Свойства подключения VPC.
VpcConnectionArn -> (строка)
IdentityProviderResourceUri -> (строка)
SparkParameters -> (структура)
Параметры для Spark.
Host -> (строка)
Port -> (целое число)
SqlServerParameters -> (структура)
Параметры для SQL Server.
Host -> (строка)
Port -> (целое число)
Database -> (строка)
TeradataParameters -> (структура)
Параметры для Teradata.
Host -> (строка)
Port -> (целое число)
Database -> (строка)
TwitterParameters -> (структура)
Параметры для Twitter.
Query -> (строка)
MaxRows -> (целое число)
AmazonOpenSearchParameters -> (структура)
Параметры для OpenSearch.
Domain -> (строка)
ExasolParameters -> (структура)
Параметры для Exasol.
Host -> (строка)
Port -> (целое число)
DatabricksParameters -> (структура)
Необходимые параметры для подключения к источнику данных Databricks.
Host -> (строка)
Port -> (целое число)
SqlEndpointPath -> (строка)
StarburstParameters -> (структура)
Параметры, необходимые для подключения к источнику данных Starburst.
Host -> (строка)
Port -> (целое число)
Catalog -> (строка)
ProductType -> (строка)
DatabaseAccessControlRole -> (строка)
AuthenticationType -> (строка)
OAuthParameters -> (структура)
Объект, содержащий информацию, необходимую для создания подключения к источнику данных между учетной записью Amazon QuickSight и Starburst.
TokenProviderUrl -> (строка)
OAuthScope -> (строка)
IdentityProviderVpcConnectionProperties -> (структура)
Свойства подключения VPC.
VpcConnectionArn -> (строка)
IdentityProviderResourceUri -> (строка)
TrinoParameters -> (структура)
Параметры, необходимые для подключения к источнику данных Trino.
Host -> (строка)
Port -> (целое число)
Catalog -> (строка)
BigQueryParameters -> (структура)
Параметры, необходимые для подключения к источнику данных Google BigQuery.
ProjectId -> (строка)
DataSetRegion -> (строка)
VpcConnectionProperties -> (структура)
Информация о подключении VPC. Вам нужно использовать этот параметр только в том случае, если вы хотите, чтобы Amazon QuickSight использовал подключение VPC при подключении к вашему исходному источнику.
VpcConnectionArn -> (строка)
SslProperties -> (структура)
Свойства Secure Socket Layer (SSL), которые применяются при подключении Amazon QuickSight к вашему исходному источнику.
DisableSsl -> (булево)
ErrorInfo -> (структура)
Информация об ошибках из последнего обновления или создания источника данных.
Type -> (строка)
Message -> (строка)
SecretArn -> (строка)
RequestId -> (строка)
Status -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.