[ aws . backupsearch ]
start-search-job
Описание
Эта операция создает задание поиска, которое возвращает точки восстановления, отфильтрованные по SearchScope, и элементы, отфильтрованные по ItemFilters.
Вы можете необязательно включить ClientToken, EncryptionKeyArn, Name и/или Tags.
См. также: Документацию AWS API
Синтаксис
start-search-job
[--tags <value>]
[--name <value>]
[--encryption-key-arn <value>]
[--client-token <value>]
--search-scope <value>
[--item-filters <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]
Параметры
--tags (карта)
Список тегов, возвращаемых операцией.
ключ -> (строка)
значение -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--name (строка)
--encryption-key-arn (строка)
--client-token (строка)
Включите этот параметр, чтобы разрешить несколько идентичных вызовов для идемпотентности.
Токен клиента действителен в течение 8 часов после завершения первого запроса, который его использует. После этого времени любой запрос с тем же токеном обрабатывается как новый запрос.
--search-scope (структура)
Этот объект может содержать BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags и SourceResourceArns для фильтрации точек восстановления, возвращаемых заданием поиска.
BackupResourceTypes -> (список)
Типы ресурсов, включенные в поиск.
Допустимые типы ресурсов включают S3 и EBS.
(строка)
BackupResourceCreationTime -> (структура)
Это время создания ресурса резервной копии.
CreatedAfter -> (временная метка)
CreatedBefore -> (временная метка)
SourceResourceArns -> (список)
Идентификатор ресурса Amazon (ARN), который однозначно идентифицирует исходные ресурсы.
(строка)
BackupResourceArns -> (список)
Идентификатор ресурса Amazon (ARN), который однозначно идентифицирует ресурсы резервной копии.
(строка)
BackupResourceTags -> (карта)
Это один или несколько тегов резервной копии (точки восстановления).
ключ -> (строка)
значение -> (строка)
Сокращенный синтаксис:
BackupResourceTypes=string,string,BackupResourceCreationTime={CreatedAfter=timestamp,CreatedBefore=timestamp},SourceResourceArns=string,string,BackupResourceArns=string,string,BackupResourceTags={KeyName1=string,KeyName2=string}
Синтаксис JSON:
{
"BackupResourceTypes": ["S3"|"EBS", ...],
"BackupResourceCreationTime": {
"CreatedAfter": timestamp,
"CreatedBefore": timestamp
},
"SourceResourceArns": ["string", ...],
"BackupResourceArns": ["string", ...],
"BackupResourceTags": {"string": "string"
...}
}
--item-filters (структура)
Фильтры элементов представляют все входные свойства элементов, указанные при создании поиска.
Содержит либо EBSItemFilters, либо S3ItemFilters
S3ItemFilters -> (список)
Этот массив может содержать объекты CreationTimes, ETags, ObjectKeys, Sizes или VersionIds.
(структура)
Это содержит массивы объектов, которые могут включать ObjectKeys, Sizes, CreationTimes, VersionIds и/или Etags.
ObjectKeys -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно значение, результаты будут возвращать только элементы, соответствующие этому значению.
Если включено более одного значения, результаты будут возвращать все элементы, соответствующие любому из значений.
(структура)
Это содержит значение строки и может содержать один или несколько операторов.
Value -> (строка)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
Sizes -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно значение, результаты будут возвращать только элементы, соответствующие этому значению.
Если включено более одного значения, результаты будут возвращать все элементы, соответствующие любому из значений.
(структура)
Условие со значением long содержит Value и может необязательно содержать Operator.
Value -> (целое число)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
CreationTimes -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно значение, результаты будут возвращать только элементы, соответствующие этому значению.
Если включено более одного значения, результаты будут возвращать все элементы, соответствующие любому из значений.
(структура)
Условие времени обозначает время создания, последнее время изменения или другое время.
Value -> (временная метка)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
VersionIds -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно значение, результаты будут возвращать только элементы, соответствующие этому значению.
Если включено более одного значения, результаты будут возвращать все элементы, соответствующие любому из значений.
(структура)
Это содержит значение строки и может содержать один или несколько операторов.
Value -> (строка)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
ETags -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно значение, результаты будут возвращать только элементы, соответствующие этому значению.
Если включено более одного значения, результаты будут возвращать все элементы, соответствующие любому из значений.
(структура)
Это содержит значение строки и может содержать один или несколько операторов.
Value -> (строка)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
EBSItemFilters -> (список)
Этот массив может содержать объекты CreationTimes, FilePaths, LastModificationTimes или Sizes.
(структура)
Это содержит массивы объектов, которые могут включать объекты условий времени CreationTimes, строки FilePaths, объекты условий времени LastModificationTimes,
FilePaths -> (список)
Вы можете включить от 1 до 10 значений.
Если включен один путь к файлу, результаты будут возвращать только элементы, соответствующие этому пути.
Если включено более одного пути к файлу, результаты будут возвращать все элементы, соответствующие любому из путей.
(структура)
Это содержит значение строки и может содержать один или несколько операторов.
Value -> (строка)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
Sizes -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно, результаты будут возвращать только соответствующие элементы.
Если включено более одного, результаты будут возвращать все элементы, соответствующие любому из включенных значений.
(структура)
Условие со значением long содержит Value и может необязательно содержать Operator.
Value -> (целое число)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
CreationTimes -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно, результаты будут возвращать только соответствующие элементы.
Если включено более одного, результаты будут возвращать все элементы, соответствующие любому из включенных значений.
(структура)
Условие времени обозначает время создания, последнее время изменения или другое время.
Value -> (временная метка)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
LastModificationTimes -> (список)
Вы можете включить от 1 до 10 значений.
Если включено одно, результаты будут возвращать только соответствующие элементы.
Если включено более одного, результаты будут возвращать все элементы, соответствующие любому из включенных значений.
(структура)
Условие времени обозначает время создания, последнее время изменения или другое время.
Value -> (временная метка)
Operator -> (строка)
Строка, определяющая, какие значения будут возвращены.
Если это включено, избегайте комбинаций операторов, которые вернут все возможные значения. Например, включение как EQUALS_TO, так и NOT_EQUALS_TO со значением 4 вернет все значения.
Синтаксис JSON:
{
"S3ItemFilters": [
{
"ObjectKeys": [
{
"Value": "string",
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"CONTAINS"|"DOES_NOT_CONTAIN"|"BEGINS_WITH"|"ENDS_WITH"|"DOES_NOT_BEGIN_WITH"|"DOES_NOT_END_WITH"
}
...
],
"Sizes": [
{
"Value": long,
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"LESS_THAN_EQUAL_TO"|"GREATER_THAN_EQUAL_TO"
}
...
],
"CreationTimes": [
{
"Value": timestamp,
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"LESS_THAN_EQUAL_TO"|"GREATER_THAN_EQUAL_TO"
}
...
],
"VersionIds": [
{
"Value": "string",
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"CONTAINS"|"DOES_NOT_CONTAIN"|"BEGINS_WITH"|"ENDS_WITH"|"DOES_NOT_BEGIN_WITH"|"DOES_NOT_END_WITH"
}
...
],
"ETags": [
{
"Value": "string",
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"CONTAINS"|"DOES_NOT_CONTAIN"|"BEGINS_WITH"|"ENDS_WITH"|"DOES_NOT_BEGIN_WITH"|"DOES_NOT_END_WITH"
}
...
]
}
...
],
"EBSItemFilters": [
{
"FilePaths": [
{
"Value": "string",
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"CONTAINS"|"DOES_NOT_CONTAIN"|"BEGINS_WITH"|"ENDS_WITH"|"DOES_NOT_BEGIN_WITH"|"DOES_NOT_END_WITH"
}
...
],
"Sizes": [
{
"Value": long,
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"LESS_THAN_EQUAL_TO"|"GREATER_THAN_EQUAL_TO"
}
...
],
"CreationTimes": [
{
"Value": timestamp,
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"LESS_THAN_EQUAL_TO"|"GREATER_THAN_EQUAL_TO"
}
...
],
"LastModificationTimes": [
{
"Value": timestamp,
"Operator": "EQUALS_TO"|"NOT_EQUALS_TO"|"LESS_THAN_EQUAL_TO"|"GREATER_THAN_EQUAL_TO"
}
...
]
}
...
]
}
--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
- 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 (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
SearchJobArn -> (строка)
CreationTime -> (метка времени)
CompletionTime точно до миллисекунд. Например, значение 1516925490.087 соответствует пятнице, 26 января 2018 года, 00:11:30.087.SearchJobIdentifier -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.