Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

list-data-lakes

Описание

Получает объект конфигурации Amazon Security Lake для указанных регионов Amazon Web Services. Вы можете использовать эту операцию, чтобы определить, включён ли Security Lake для региона.

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

Синтаксис

  list-data-lakes
[--regions <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]

Параметры

--regions (список)

Список регионов, в которых включён Security Lake.

(строка)

Синтаксис:

"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
  • text
  • таблица
  • 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробная информация приведена в руководстве по началу работы с AWS CLI в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI.

Чтобы получить список объектов конфигурации Security Lake

Следующий list-data-lakes пример выводит объект конфигурации Amazon Security Lake для указанного AWS региона. Вы можете использовать эту команду, чтобы определить, включён ли Security Lake в указанном регионе или регионах.

aws securitylake list-data-lakes \
    --regions "us-east-1"

Вывод:

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-1:123456789012:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-1",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:123456789012:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-1-1234567890abcdef0",
            "updateStatus": {
                "exception": {
                    "code": "software.amazon.awssdk.services.s3.model.S3Exception",
                    "reason": ""
                },
                "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
                "status": "FAILED"
            }
        }
    ]
}

Для получения дополнительной информации см. Проверка статуса региона в руководстве пользователя Amazon Security Lake.

Вывод

dataLakes -> (список)

Получает объект конфигурации Security Lake.

(структура)

Предоставляет подробности об объекте Amazon Security Lake.

createStatus -> (строка)

Возвращает состояние вызова API CreateDatalake для учетной записи в Amazon Security Lake.

dataLakeArn -> (строка)

Идентификатор ресурса Amazon (ARN), созданный вами для предоставления подписчику. Дополнительную информацию об ARN и о том, как их использовать в политиках, см. в руководстве пользователя Amazon Security Lake.

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

Предоставляет подробности об шифровании объекта Amazon Security Lake.

kmsKeyId -> (строка)

Идентификатор ключа шифрования KMS, используемого Amazon Security Lake для шифрования объекта Security Lake.

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

Предоставляет сведения о жизненном цикле объекта Amazon Security Lake.

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

Предоставляет сведения о времени истечения срока действия данных объекта Amazon Security Lake.

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

Количество дней до истечения срока действия данных в объекте Amazon Security Lake.

transitions -> (список)

Предоставляет сведения о переходе хранения данных объекта Amazon Security Lake.

(структура)

Предоставляют подробности о жизненном цикле переходов объекта Amazon Security Lake.

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

Количество дней до перехода данных в другой класс хранилища S3 в объекте Amazon Security Lake.

storageClass -> (строка)

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

region -> (строка)

Регионы Amazon Web Services, в которых включён Security Lake.

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

Предоставляет сведения о репликации объекта Amazon Security Lake.

regions -> (список)

Указывает один или несколько централизованных регионов агрегирования. Регион Amazon Web Services, указанный в параметре region операций ` CreateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html`__ или ` UpdateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_UpdateDataLake.html`__ добавляет данные в регион или регионы агрегирования, указанные в этом параметре.

Репликация позволяет автоматически и асинхронно копировать объекты между хранилищами Amazon S3. Хранилища S3, которые настроены для репликации объектов, могут принадлежать одному и тому же аккаунту Amazon Web Services или разным аккаунтам. Вы можете реплицировать объекты в одно целевое хранилище или в несколько целевых хранилищ. Целевые хранилища могут находиться в разных регионах или в том же регионе, что и исходное хранилище.

(строка)

roleArn -> (строка)

Настройки репликации для хранилищ Amazon S3. Этот параметр использует роль управления идентификацией и доступом (IAM), созданную вами и управляемую Security Lake, чтобы убедиться, что параметры репликации корректны.

s3BucketArn -> (строка)

ARN для хранилища Amazon S3 Amazon Security Lake.

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

Состояние последнего запроса API UpdateDataLake или DeleteDataLake.

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

Подробности последнего запроса API UpdateDataLake или DeleteDataLake, который завершился ошибкой.

code -> (строка)

Код причины ошибки последнего запроса API UpdateDataLake или DeleteDataLake.

reason -> (строка)

Причина ошибки последнего запроса API UpdateDataLake или DeleteDataLake.

requestId -> (строка)

Уникальный идентификатор последнего запроса API UpdateDataLake или DeleteDataLake.

status -> (строка)

Состояние последнего запроса API UpdateDataLake или DeleteDataLake.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API