search-resources

Описание

Получает (запрашивает) статистические данные и другую информацию об ресурсах Amazon Web Services, которые отслеживаются и анализируются Amazon Macie для учетной записи.

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

search-resources является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответном значении постраничной операции, аргумент --query должен извлечь данные из результатов следующих выражений запроса: matchingResources

Синтаксис

  search-resources
[--bucket-criteria <value>]
[--sort-criteria <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]

Параметры

--bucket-criteria (структура)

Условия фильтрации, определяющие, какие S3-баки включать или исключать из результатов запроса.

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

Условия, основанные на свойствах и тегах, определяющие, какие баки исключить из результатов.

and -> (список)

Массив объектов, по одному для каждого условия, основанного на свойствах или тегах, которое включает или исключает ресурсы из результатов запроса. Если вы указываете более одного условия, Amazon Macie использует логику И для объединения условий.

(структура)

Указывает условие фильтрации, основанное на свойствах или тегах, для включения или исключения ресурсов Amazon Web Services из результатов запроса.

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

Условие, основанное на свойствах, которое определяет свойство, оператор и одно или несколько значений для включения или исключения ресурсов из результатов.

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения: EQ (равно) и NE (не равно).

key -> (строка)

Свойство, используемое в условии.

values -> (список)

Массив, содержащий одно или несколько значений для использования в условии. Если вы указываете несколько значений, Amazon Macie использует логику ИЛИ для объединения значений. Допустимые значения для каждого поддерживаемого свойства (ключа):

ACCOUNT_ID - Строка, представляющая уникальный идентификатор учетной записи Amazon Web Services, владеющей ресурсом.
AUTOMATED_DISCOVERY_MONITORING_STATUS - Строка, представляющая перечисление значений, определенных Macie для свойства BucketMetadata.automatedDiscoveryMonitoringStatus S3-бака.
S3_BUCKET_EFFECTIVE_PERMISSION - Строка, представляющая перечисление значений, определенных Macie для свойства BucketPublicAccess.effectivePermission S3-бака.
S3_BUCKET_NAME - Строка, представляющая имя S3-бака.
S3_BUCKET_SHARED_ACCESS - Строка, представляющая перечисление значений, определенных Macie для свойства BucketMetadata.sharedAccess S3-бака.

Значения чувствительны к регистру. Также Macie не поддерживает использование частичных значений или символов подстановки в значениях.

(строка)

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

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

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения: EQ (равно) и NE (не равно).

tagValues -> (список)

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

(структура)

Указывает ключ тега, значение тега или пару ключ-значение (как пару) для использования в условии фильтрации тегов для запроса. Ключи и значения тегов чувствительны к регистру. Также Amazon Macie не поддерживает использование частичных значений или символов подстановки в условиях фильтрации тегов.

key -> (строка)

Значение для ключа тега для использования в условии.

value -> (строка)

Значение тега для использования в условии.

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

Условия, основанные на свойствах и тегах, определяющие, какие баки включать в результаты.

and -> (список)

(структура)

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

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения: EQ (равно) и NE (не равно).

key -> (строка)

Свойство, используемое в условии.

values -> (список)

ACCOUNT_ID - Строка, представляющая уникальный идентификатор учетной записи Amazon Web Services, владеющей ресурсом.
AUTOMATED_DISCOVERY_MONITORING_STATUS - Строка, представляющая перечисление значений, определенных Macie для свойства BucketMetadata.automatedDiscoveryMonitoringStatus S3-бака.
S3_BUCKET_EFFECTIVE_PERMISSION - Строка, представляющая перечисление значений, определенных Macie для свойства BucketPublicAccess.effectivePermission S3-бака.
S3_BUCKET_NAME - Строка, представляющая имя S3-бака.
S3_BUCKET_SHARED_ACCESS - Строка, представляющая перечисление значений, определенных Macie для свойства BucketMetadata.sharedAccess S3-бака.

(строка)

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

comparator -> (строка)

Оператор, используемый в условии. Допустимые значения: EQ (равно) и NE (не равно).

tagValues -> (список)

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

(структура)

key -> (строка)

Значение для ключа тега для использования в условии.

value -> (строка)

Значение тега для использования в условии.

Синтаксис JSON:

{
  "excludes": {
    "and": [
      {
        "simpleCriterion": {
          "comparator": "EQ"|"NE",
          "key": "ACCOUNT_ID"|"S3_BUCKET_NAME"|"S3_BUCKET_EFFECTIVE_PERMISSION"|"S3_BUCKET_SHARED_ACCESS"|"AUTOMATED_DISCOVERY_MONITORING_STATUS",
          "values": ["string", ...]
        },
        "tagCriterion": {
          "comparator": "EQ"|"NE",
          "tagValues": [
            {
              "key": "string",
              "value": "string"
            }
            ...
          ]
        }
      }
      ...
    ]
  },
  "includes": {
    "and": [
      {
        "simpleCriterion": {
          "comparator": "EQ"|"NE",
          "key": "ACCOUNT_ID"|"S3_BUCKET_NAME"|"S3_BUCKET_EFFECTIVE_PERMISSION"|"S3_BUCKET_SHARED_ACCESS"|"AUTOMATED_DISCOVERY_MONITORING_STATUS",
          "values": ["string", ...]
        },
        "tagCriterion": {
          "comparator": "EQ"|"NE",
          "tagValues": [
            {
              "key": "string",
              "value": "string"
            }
            ...
          ]
        }
      }
      ...
    ]
  }
}

--sort-criteria (структура)

Критерии для сортировки результатов.

attributeName -> (строка)

Свойство для сортировки результатов.

orderBy -> (строка)

Порядок сортировки результатов, основанный на значении свойства, указанном в свойстве attributeName. Допустимые значения: ASC, сортировать результаты в порядке возрастания; и DESC, сортировать результаты в порядке убывания.

Сокращенный синтаксис:

attributeName=string,orderBy=string

Синтаксис JSON:

{
  "attributeName": "ACCOUNT_ID"|"RESOURCE_NAME"|"S3_CLASSIFIABLE_OBJECT_COUNT"|"S3_CLASSIFIABLE_SIZE_IN_BYTES",
  "orderBy": "ASC"|"DESC"
}

--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 (boolean)

Включить отладочную запись журнала.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

matchingResources -> (список)

Массив объектов, по одному для каждого ресурса, соответствующего критериям фильтра, указанным в запросе.

(структура)

Предоставляет статистические данные и другую информацию о ресурсе Amazon Web Services, который Amazon Macie отслеживает и анализирует для вашей учетной записи.

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

Подробная информация об S3-бакете, который Amazon Macie отслеживает и анализирует для вашей учетной записи.

accountId -> (строка)

Уникальный идентификатор учетной записи Amazon Web Services, которой принадлежит бакет.

automatedDiscoveryMonitoringStatus -> (строка)

Указывает, настроено ли автоматическое обнаружение конфиденциальных данных для анализа объектов в бакете. Возможные значения: MONITORED — бакет включен в анализы; и NOT_MONITORED — бакет исключен из анализов. Если автоматическое обнаружение конфиденциальных данных отключено для вашей учетной записи, это значение равно NOT_MONITORED.

bucketName -> (строка)

Имя бакета.

classifiableObjectCount -> (длинное целое)

Общее количество объектов, которые Amazon Macie может проанализировать в бакете. Эти объекты используют поддерживаемый класс хранения и имеют расширение имени файла для поддерживаемого файла или формата хранения.

classifiableSizeInBytes -> (длинное целое)

Общий объем хранилища в байтах объектов, которые Amazon Macie может проанализировать в бакете. Эти объекты используют поддерживаемый класс хранения и имеют расширение имени файла для поддерживаемого файла или формата хранения.

Если для бакета включена версия, Macie рассчитывает это значение на основе размера последней версии каждого соответствующего объекта в бакете. Это значение не отражает объем хранилища всех версий каждого соответствующего объекта в бакете.

errorCode -> (строка)

Код ошибки или проблемы, которая помешала Amazon Macie получить и обработать информацию о бакете и объектах бакета. Возможные значения:

ACCESS_DENIED — у Macie нет разрешения на получение информации. Например, у бакета есть ограниченная политика бакета, и Amazon S3 отклонил запрос.
BUCKET_COUNT_EXCEEDS_QUOTA — получение и обработка информации превысит квоту на количество бакетов, которые Macie отслеживает для учетной записи (10 000).

Если это значение равно null, Macie смог получить и обработать информацию.

errorMessage -> (строка)

Краткое описание ошибки или проблемы (errorCode), которая помешала Amazon Macie получить и обработать информацию о бакете и объектах бакета. Это значение равно null, если Macie смог получить и обработать информацию.

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

Указывает, настроены ли одноразовые или повторяющиеся задачи классификации для анализа объектов в бакете, и, если да, подробности о последней выполненной задаче.

isDefinedInJob -> (строка)

Указывает, настроены ли одноразовые или повторяющиеся задачи для анализа объектов в бакете. Возможные значения:

TRUE — бакет явно включен в определение бакета (S3BucketDefinitionForJob) для одной или нескольких задач, и по крайней мере одна из этих задач имеет статус, отличный от CANCELLED. Или бакет соответствовал критериям бакета (S3BucketCriteriaForJob) для по крайней мере одной задачи, которая была выполнена ранее.
FALSE — бакет не включен явно в определение бакета (S3BucketDefinitionForJob) для любых задач, все задачи, которые явно включают бакет в их определения бакетов, имеют статус CANCELLED, или бакет не соответствовал критериям бакета (S3BucketCriteriaForJob) для любых задач, которые были выполнены ранее.
UNKNOWN — при попытке Amazon Macie получить данные о задачах для бакета произошла ошибка.

isMonitoredByJob -> (строка)

Указывает, настроены ли повторяющиеся задачи для анализа объектов в бакете. Возможные значения:

TRUE — бакет явно включен в определение бакета (S3BucketDefinitionForJob) для одной или нескольких повторяющихся задач, или бакет соответствует критериям бакета (S3BucketCriteriaForJob) для одной или нескольких повторяющихся задач. По крайней мере одна из этих задач имеет статус, отличный от CANCELLED.
FALSE — бакет не включен явно в определение бакета (S3BucketDefinitionForJob) для каких-либо повторяющихся задач, бакет не соответствует критериям бакета (S3BucketCriteriaForJob) для каких-либо повторяющихся задач или все повторяющиеся задачи, которые настроены для анализа данных в бакете, имеют статус CANCELLED.
UNKNOWN — при попытке Amazon Macie получить данные о задачах для бакета произошла ошибка.

lastJobId -> (строка)

Уникальный идентификатор задачи, которая была выполнена последней и настроена для анализа объектов в бакете, будь то последнее выполнение повторяющейся задачи или единственное выполнение одноразовой задачи.

Это значение обычно равно null, если значение свойства isDefinedInJob равно FALSE или UNKNOWN.

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

Дата и время в формате UTC и расширенном формате ISO 8601, когда началась задача (lastJobId). Если задача является повторяющейся задачей, это значение указывает, когда началось последнее выполнение.

Это значение обычно равно null, если значение свойства isDefinedInJob равно FALSE или UNKNOWN.

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

Дата и время в формате UTC и расширенном формате ISO 8601, когда Amazon Macie в последний раз анализировал объекты в бакете во время выполнения автоматического обнаружения конфиденциальных данных. Это значение равно null, если такой анализ не производился.

objectCount -> (длинное целое)

Общее количество объектов в бакете.

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

Общее количество объектов в бакете, сгруппированных по типу шифрования на стороне сервера. Это включает группировку, которая сообщает о количестве объектов, которые не зашифрованы или используют шифрование на стороне клиента.

customerManaged -> (длинное целое)

Общее количество объектов, зашифрованных с помощью предоставленных клиентом ключей. Объекты используют шифрование на стороне сервера с предоставленными клиентом ключами (SSE-C).

kmsManaged -> (длинное целое)

Общее количество объектов, зашифрованных с помощью ключей KMS, управляемых Amazon Web Services или клиентом. Объекты используют двухслойное шифрование на стороне сервера или шифрование на стороне сервера с помощью ключей KMS (DSSE-KMS или SSE-KMS).

s3Managed -> (длинное целое)

Общее количество объектов, зашифрованных с помощью ключей, управляемых Amazon S3. Объекты используют шифрование на стороне сервера с управляемыми Amazon S3 ключами (SSE-S3).

unencrypted -> (длинное целое)

Общее количество объектов, которые используют шифрование на стороне клиента или не зашифрованы.

unknown -> (длинное целое)

Общее количество объектов, для которых Amazon Macie не имеет текущих метаданных шифрования. Macie не может предоставить текущие данные о настройках шифрования для этих объектов.

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

Оценка конфиденциальности бакета, изменяющаяся от -1 (ошибка классификации) до 100 (конфиденциальный).

Если автоматическое обнаружение конфиденциальных данных никогда не включалось для вашей учетной записи или было отключено для вашей организации или самостоятельной учетной записи более 30 дней, возможные значения: 1 — бакет пуст; или 50 — бакет хранит объекты, но он был исключен из недавних анализов.

sizeInBytes -> (длинное целое)

Общий объем хранилища в байтах бакета.

Если для бакета включена версия, Amazon Macie рассчитывает это значение на основе размера последней версии каждого объекта в бакете. Это значение не отражает объем хранилища всех версий каждого объекта в бакете.

sizeInBytesCompressed -> (длинное целое)

Общий объем хранилища в байтах сжатых файлов (.gz, .gzip, .zip) в бакете.

Если для бакета включена версия, Amazon Macie рассчитывает это значение на основе размера последней версии каждого соответствующего объекта в бакете. Это значение не отражает объем хранилища всех версий каждого соответствующего объекта в бакете.

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

Общее количество объектов, которые Amazon Macie не может проанализировать в бакете. Эти объекты не используют поддерживаемый класс хранения или не имеют расширения имени файла для поддерживаемого файла или формата хранения.

fileType -> (длинное целое)

Общий объем хранилища (в байтах) или количество объектов, которые Amazon Macie не может проанализировать, потому что у объектов нет расширения имени файла для поддерживаемого файла или формата хранения.

storageClass -> (длинное целое)

Общий объем хранилища (в байтах) или количество объектов, которые Amazon Macie не может проанализировать, потому что объекты используют неподдерживаемый класс хранения.

total -> (длинное целое)

Общий объем хранилища (в байтах) или количество объектов, которые Amazon Macie не может проанализировать, потому что объекты используют неподдерживаемый класс хранения или не имеют расширения имени файла для поддерживаемого файла или формата хранения.

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

Общий объем хранилища в байтах объектов, которые Amazon Macie не может проанализировать в бакете. Эти объекты не используют поддерживаемый класс хранения или не имеют расширения имени файла для поддерживаемого файла или формата хранения.

fileType -> (длинное целое)

storageClass -> (длинное целое)

total -> (длинное целое)

nextToken -> (строка)

Строка, используемая в последующем запросе для получения следующей страницы результатов в ответах с постраничной навигацией. Это значение равно null, если дополнительных страниц нет.