Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

get-subscriber

Описание

Получает информацию о подписке для указанного идентификатора подписки. Можно получить информацию о конкретном подписчике.

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

Синтаксис

  get-subscriber
--subscriber-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]

Параметры

--subscriber-id (строка)

Значение, созданное Amazon Security Lake, которое уникально идентифицирует ваш запрос API GetSubscriber.

--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.

Примеры

Примечание

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

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

Для получения информации о подписке

Следующий get-subscriber пример получает информацию о подписке для указанного подписчика Securiy Lake.

aws securitylake get-subscriber \
    --subscriber-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "subscriber": {
        "accessTypes": [
            "LAKEFORMATION"
        ],
        "createdAt": "2024-04-19T15:19:44.421803+00:00",
        "resourceShareArn": "arn:aws:ram:eu-west-2:123456789012:resource-share/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "resourceShareName": "LakeFormation-V3-TKJGBHCKTZ-123456789012",
        "sources": [
            {
                "awsLogSource": {
                    "sourceName": "LAMBDA_EXECUTION",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "EKS_AUDIT",
                    "sourceVersion": "2.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "ROUTE53",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "SH_FINDINGS",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "VPC_FLOW",
                    "sourceVersion": "1.0"
                }
            },
            {
                "customLogSource": {
                    "attributes": {
                        "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/testCustom2",
                        "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/amazon_security_lake_glue_db_eu_west_2",
                        "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/amazon_security_lake_table_eu_west_2_ext_testcustom2"
                    },
                    "provider": {
                        "location": "s3://aws-security-data-lake-eu-west-2-8ugsus4ztnsfpjbldwbgf4vge98av9/ext/testCustom2/",
                        "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-Provider-testCustom2-eu-west-2"
                    },
                    "sourceName": "testCustom2"
                }
            },
            {
                "customLogSource": {
                    "attributes": {
                        "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/TestCustom",
                        "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/amazon_security_lake_glue_db_eu_west_2",
                        "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/amazon_security_lake_table_eu_west_2_ext_testcustom"
                    },
                    "provider": {
                        "location": "s3://aws-security-data-lake-eu-west-2-8ugsus4ztnsfpjbldwbgf4vge98av9/ext/TestCustom/",
                        "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-Provider-TestCustom-eu-west-2"
                    },
                    "sourceName": "TestCustom"
                }
            }
        ],
        "subscriberArn": "arn:aws:securitylake:eu-west-2:123456789012:subscriber/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberIdentity": {
            "externalId": "123456789012",
            "principal": "123456789012"
        },
        "subscriberName": "test",
        "subscriberStatus": "ACTIVE",
        "updatedAt": "2024-04-19T15:19:55.230588+00:00"
    }
}

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

Вывод

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

Информация о подписчике для указанного идентификатора подписчика.

accessTypes -> (список)

Можно настроить уведомления подписчикам о новых объектах с помощью очереди Amazon Simple Queue Service (Amazon SQS) или через сообщение на предоставленный подписчиком HTTPS-точек.

Подписчики могут получать данные, напрямую запрашивая таблицы Lake Formation в вашем Amazon S3-бакете через такие сервисы, как Amazon Athena. Этот тип подписки определен как LAKEFORMATION.

(строка)

createdAt -> (метка времени)

Дата и время создания подписчика.

resourceShareArn -> (строка)

Amazon Resource Name (ARN), который уникально определяет совместное использование ресурсов Amazon Web Services RAM. Перед принятием приглашения совместного использования ресурсов RAM, можно просмотреть детали, связанные с совместным использованием ресурсов RAM.

Это поле доступно только для подписчиков Lake Formation, созданных после 8 марта 2023 года.

resourceShareName -> (строка)

Название совместного использования ресурсов.

roleArn -> (строка)

Amazon Resource Name (ARN), указывающий роль подписчика.

s3BucketArn -> (строка)

ARN для Amazon S3-бакета.

sources -> (список)

Amazon Security Lake поддерживает сбор журналов и событий для нативно поддерживаемых служб Amazon Web Services. Дополнительную информацию см. в Руководстве пользователя Amazon Security Lake.

(структура помеченного объединения)

Поддерживаемые типы источников, из которых собираются журналы и события в Amazon Security Lake. Список поддерживаемых служб Amazon Web Services см. в Руководстве пользователя Amazon Security Lake.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: awsLogSource, customLogSource.

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

Amazon Security Lake поддерживает сбор журналов и событий для нативно поддерживаемых служб Amazon Web Services. Дополнительную информацию см. в Руководстве пользователя Amazon Security Lake.

sourceName -> (строка)

Имя источника Amazon Web Services. Должно быть уникальным в регионе.

sourceVersion -> (строка)

Версия источника Amazon Web Services. Должна быть уникальной в регионе.

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

Amazon Security Lake поддерживает пользовательские типы источников. Дополнительную информацию см. в Руководстве пользователя Amazon Security Lake.

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

Атрибуты стороннего пользовательского источника.

crawlerArn -> (строка)

ARN хранилища Glue.

databaseArn -> (строка)

ARN базы данных Glue, куда записываются результаты, например: arn:aws:daylight:us-east-1::database/sometable/*.

tableArn -> (строка)

ARN таблицы Glue.

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

Детали поставщика журналов для стороннего пользовательского источника.

location -> (строка)

Расположение раздела в Amazon S3-бакете для Security Lake.

roleArn -> (строка)

ARN IAM-роли, которая будет использоваться сущностью, помещающей журналы в раздел вашего пользовательского источника. Security Lake применит соответствующие политики доступа к этой роли, но вы должны предварительно вручную создать политику доверия для этой роли. Имя IAM-роли должно начинаться со строки ‘Security Lake’. IAM-роль должна доверять logProviderAccountId для взятия на себя роли.

sourceName -> (строка)

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

sourceVersion -> (строка)

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

subscriberArn -> (строка)

ARN подписчика учетной записи Amazon Security Lake.

subscriberDescription -> (строка)

Описание подписчика учетной записи. Описание подписчика включает subscriberName, accountID, externalID и subscriberId.

subscriberEndpoint -> (строка)

Адрес подписчика, на который отправляются сообщения об исключениях.

subscriberId -> (строка)

Идентификатор подписчика учетной записи Amazon Security Lake.

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

Идентификатор Amazon Web Services, используемый для доступа к данным.

externalId -> (строка)

Внешний идентификатор, используемый для установления отношений доверия с идентификатором Amazon Web Services.

principal -> (строка)

Принципал идентификатора Amazon Web Services.

subscriberName -> (строка)

Имя вашей учетной записи Amazon Security Lake подписчика.

subscriberStatus -> (строка)

Статус подписчика учетной записи Amazon Security Lake подписчика.

updatedAt -> (метка времени)

Дата и время последнего обновления подписчика.

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

Spec-Zone.ru

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