[ aws . quicksight ]
list-data-sources
Описание
Отображает источники данных в текущем регионе Amazon Web Services, принадлежащие данной учетной записи Amazon Web Services.
См. также: Документацию API AWS
list-data-sources это постраничная операция. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной выдачей, аргумент --query должен извлечь данные из результатов следующих выражений запроса: DataSources
Синтаксис
list-data-sources
--aws-account-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные данные с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания, с какой точки начать постраничный вывод. Это NextToken из ранее укороченного ответа.
Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.
--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--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-auto-prompt (булево)
Автоматически запросить параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запрошение параметров ввода командной строки.
Вывод
DataSources -> (список)
Список источников данных.
(структура)
Структура источника данных.
Arn -> (строка)
DataSourceId -> (строка)
Name -> (строка)
Type -> (строка)
Status -> (строка)
CreatedTime -> (метка времени)
LastUpdatedTime -> (метка времени)
DataSourceParameters -> (структура)
Параметры, используемые Amazon QuickSight для подключения к вашему исходному источнику. Это структура переменного типа. Для корректности этой структуры может быть непустым только один из атрибутов.
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 -> (строка)
AlternateDataSourceParameters -> (список)
Набор альтернативных параметров источника данных, которые вы хотите использовать для учетных данных, хранящихся в этом источнике данных. Учетные данные применяются вместе с параметрами источника данных при копировании источника данных с помощью запроса создания или обновления. API-операция сравнивает структуру DataSourceParameters в запросе со структурами в списке разрешенных структур AlternateDataSourceParameters. Если структуры точно совпадают, запрос разрешается использовать учетные данные из этого существующего источника данных. Если список AlternateDataSourceParameters равен null, то учетные данные Credentials, изначально использованные с этим DataSourceParameters, автоматически разрешаются.
(структура)
Параметры, которые Amazon QuickSight использует для подключения к вашему исходному источнику данных. Это структура переменного типа. Для того, чтобы эта структура была валидной, только один из атрибутов может быть не null.
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 -> (string)
Port -> (integer)
Catalog -> (string)
ProductType -> (string)
DatabaseAccessControlRole -> (string)
AuthenticationType -> (string)
OAuthParameters -> (structure)
Объект, содержащий информацию, необходимую для создания подключения к источнику данных между учетной записью Amazon QuickSight и Starburst.
TokenProviderUrl -> (string)
OAuthScope -> (string)
IdentityProviderVpcConnectionProperties -> (structure)
Свойства подключения VPC.
VpcConnectionArn -> (string)
IdentityProviderResourceUri -> (string)
TrinoParameters -> (structure)
Параметры, необходимые для подключения к источнику данных Trino.
Host -> (string)
Port -> (integer)
Catalog -> (string)
BigQueryParameters -> (structure)
Параметры, необходимые для подключения к источнику данных Google BigQuery.
ProjectId -> (string)
DataSetRegion -> (string)
VpcConnectionProperties -> (structure)
Информация о подключении VPC. Вам необходимо использовать этот параметр только в том случае, если вы хотите, чтобы Amazon QuickSight использовал подключение VPC при подключении к вашему исходному источнику.
VpcConnectionArn -> (string)
SslProperties -> (structure)
Свойства Secure Socket Layer (SSL), применяемые при подключении Amazon QuickSight к вашему исходному источнику.
DisableSsl -> (boolean)
ErrorInfo -> (structure)
Информация об ошибках из последнего обновления или создания источника данных.
Type -> (string)
Message -> (string)
SecretArn -> (string)
NextToken -> (string)
RequestId -> (string)
Status -> (integer)
© Copyright 2025, Amazon Web Services. Created using Sphinx.