[ aws . clouddirectory ]
batch-read
Описание
Выполняет все операции чтения в пакетном режиме.
См. также: Документацию AWS API
Синтаксис
batch-read
--directory-arn <value>
--operations <value>
[--consistency-level <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]
Параметры
--directory-arn (строка)
--operations (список)
Список операций, входящих в пакет.
(структура)
Представляет результат операции BatchRead.
ListObjectAttributes -> (структура)
Перечисляет все атрибуты, связанные с объектом.
ObjectReference -> (структура)
Ссылка на объект, атрибуты которого требуется перечислить.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по ссылкам родитель-потомок, ведущим от корня каталога. Используйте имена ссылок каждого родительского/дочернего звена для построения пути. Селекторы путей начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Для получения дополнительной информации о путях см. Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставляет идентификатор созданного объекта. Идентификатор объекта неизменяем, и два объекта никогда не будут иметь одинаковый идентификатор. Для идентификации объекта с ObjectIdentifier ObjectIdentifier необходимо заключить в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
NextToken -> (строка)
MaxResults -> (целое число)
FacetFilter -> (структура)
Используется для фильтрации списка атрибутов объекта, связанных с определенным аспектом.
SchemaArn -> (строка)
FacetName -> (строка)
ListObjectChildren -> (структура)
Возвращает постраничный список дочерних объектов, связанных с заданным объектом.
ObjectReference -> (структура)
Ссылка на объект, для которого перечисляются дочерние объекты.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по ссылкам родитель-потомок, ведущим от корня каталога. Используйте имена ссылок каждого родительского/дочернего звена для построения пути. Селекторы путей начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Для получения дополнительной информации о путях см. Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставляет идентификатор созданного объекта. Идентификатор объекта неизменяем, и два объекта никогда не будут иметь одинаковый идентификатор. Для идентификации объекта с ObjectIdentifier ObjectIdentifier необходимо заключить в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
NextToken -> (строка)
MaxResults -> (целое число)
ListAttachedIndices -> (структура)
Перечисляет индексы, присоединенные к объекту.
TargetReference -> (структура)
Ссылка на объект, к которому присоединены индексы.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по ссылкам родитель-потомок, ведущим от корня каталога. Используйте имена ссылок каждого родительского/дочернего звена для построения пути. Селекторы путей начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Для получения дополнительной информации о путях см. Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставляет идентификатор созданного объекта. Идентификатор объекта неизменяем, и два объекта никогда не будут иметь одинаковый идентификатор. Для идентификации объекта с ObjectIdentifier ObjectIdentifier необходимо заключить в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
NextToken -> (строка)
MaxResults -> (целое число)
ListObjectParentPaths -> (структура)
Получает все доступные родительские пути для любого типа объектов, таких как узлы, листовые узлы, узлы политики и узлы индексов. Для получения дополнительной информации об объектах см. Структура каталога.
ObjectReference -> (структура)
Ссылка, определяющая объект, атрибуты которого будут перечислены.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по ссылкам родитель-потомок, ведущим от корня каталога. Используйте имена ссылок каждого родительского/дочернего звена для построения пути. Селекторы путей начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Для получения дополнительной информации о путях см. Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставляет идентификатор созданного объекта. Идентификатор объекта неизменяем, и два объекта никогда не будут иметь одинаковый идентификатор. Для идентификации объекта с ObjectIdentifier ObjectIdentifier необходимо заключить в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
NextToken -> (строка)
MaxResults -> (целое число)
GetObjectInformation -> (структура)
Получает метаданные об объекте.
ObjectReference -> (структура)
Ссылка на объект.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по ссылкам родитель-потомок, ведущим от корня каталога. Используйте имена ссылок каждого родительского/дочернего звена для построения пути. Селекторы путей начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Для получения дополнительной информации о путях см. Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставляет идентификатор созданного объекта. Идентификатор объекта неизменяем, и два объекта никогда не будут иметь одинаковый идентификатор. Для идентификации объекта с ObjectIdentifier ObjectIdentifier необходимо заключить в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
GetObjectAttributes -> (структура)
Получает атрибуты в рамках аспекта, связанные с объектом.
ObjectReference -> (структура)
Ссылка, определяющая объект, атрибуты которого будут получены.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по ссылкам родитель-потомок, ведущим от корня каталога. Используйте имена ссылок каждого родительского/дочернего звена для построения пути. Селекторы путей начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Для получения дополнительной информации о путях см. Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставляет идентификатор созданного объекта. Идентификатор объекта неизменяем, и два объекта никогда не будут иметь одинаковый идентификатор. Для идентификации объекта с ObjectIdentifier ObjectIdentifier необходимо заключить в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
SchemaFacet -> (структура)
Идентификатор аспекта, атрибуты которого будут получены. См. SchemaFacet для подробностей.
SchemaArn -> (строка)
FacetName -> (строка)
AttributeNames -> (список)
Список имен атрибутов, значения которых будут получены.
(строка)
ListObjectParents -> (структура)
Перечисляет родительские объекты, связанные с заданным объектом, в постраничном режиме.
ObjectReference -> (структура)
Ссылка, определяющая объект.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по ссылкам родитель-потомок, ведущим от корня каталога. Используйте имена ссылок каждого родительского/дочернего звена для построения пути. Селекторы путей начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Для получения дополнительной информации о путях см. Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставляет идентификатор созданного объекта. Идентификатор объекта неизменяем, и два объекта никогда не будут иметь одинаковый идентификатор. Для идентификации объекта с ObjectIdentifier ObjectIdentifier необходимо заключить в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
NextToken -> (строка)
MaxResults -> (целое число)
ListObjectPolicies -> (структура)
Возвращает политики, прикрепленные к объекту, в режиме постраничной навигации.
ObjectReference -> (структура)
Ссылка, идентифицирующая объект, атрибуты которого будут перечислены.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по родительским/дочерним ссылкам, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/дочернего элемента для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемая строка, предоставляемая Amazon Cloud Directory. При создании объектов система предоставляет вам идентификатор созданного объекта. Идентификатор объекта неизменяем, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Чтобы идентифицировать объект с помощью ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
NextToken -> (строка)
MaxResults -> (целое число)
ListPolicyAttachments -> (структура)
Возвращает все ObjectIdentifiers, к которым прикреплена данная политика.
PolicyReference -> (структура)
Ссылка, идентифицирующая объект политики.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по родительским/дочерним ссылкам, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/дочернего элемента для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемая строка, предоставляемая Amazon Cloud Directory. При создании объектов система предоставляет вам идентификатор созданного объекта. Идентификатор объекта неизменяем, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Чтобы идентифицировать объект с помощью ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
NextToken -> (строка)
MaxResults -> (целое число)
LookupPolicy -> (структура)
Перечисляет все политики от корня каталога до указанного объекта. Если политики отсутствуют, возвращается пустой список. Если политики присутствуют, и если некоторые объекты не имеют прикрепленных политик, возвращается ObjectIdentifier для таких объектов. Если политики присутствуют, возвращается ObjectIdentifier, policyId и policyType. Пути, которые не ведут к корню из целевого объекта, игнорируются. Дополнительную информацию см. в разделе Политики .
ObjectReference -> (структура)
Ссылка, идентифицирующая объект, политики которого будут найдены.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по родительским/дочерним ссылкам, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/дочернего элемента для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемая строка, предоставляемая Amazon Cloud Directory. При создании объектов система предоставляет вам идентификатор созданного объекта. Идентификатор объекта неизменяем, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Чтобы идентифицировать объект с помощью ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
NextToken -> (строка)
MaxResults -> (целое число)
ListIndex -> (структура)
Перечисляет объекты, прикрепленные к указанному индексу.
RangesOnIndexedValues -> (список)
Указывает диапазоны индексированных значений, которые вы хотите запросить.
(структура)
Диапазон атрибутов.
AttributeKey -> (структура)
Ключ атрибута, который покрывает диапазон атрибутов.
SchemaArn -> (строка)
FacetName -> (строка)
Name -> (строка)
Range -> (структура)
Диапазон значений атрибутов, выбираемых в данный момент.
StartMode -> (строка)
StartValue -> (структура)
Значение, с которого начинается диапазон.
StringValue -> (строка)
BinaryValue -> (двоичные данные)
BooleanValue -> (булево)
NumberValue -> (строка)
DatetimeValue -> (метка времени)
EndMode -> (строка)
EndValue -> (структура)
Значение атрибута, по которому завершается диапазон.
StringValue -> (строка)
BinaryValue -> (двоичные данные)
BooleanValue -> (булево)
NumberValue -> (строка)
DatetimeValue -> (метка времени)
IndexReference -> (структура)
Ссылка на индекс для перечисления.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по родительским/дочерним ссылкам, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/дочернего элемента для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемая строка, предоставляемая Amazon Cloud Directory. При создании объектов система предоставляет вам идентификатор созданного объекта. Идентификатор объекта неизменяем, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Чтобы идентифицировать объект с помощью ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
MaxResults -> (целое число)
NextToken -> (строка)
ListOutgoingTypedLinks -> (структура)
Возвращает постраничный список всей информации об исходящих указателях TypedLinkSpecifier для объекта. Он также поддерживает фильтрацию по фасету типов ссылок и атрибутам идентификации. Дополнительную информацию см. в разделе Типизированные ссылки .
ObjectReference -> (структура)
Ссылка, идентифицирующая объект, атрибуты которого будут перечислены.
Selector -> (строка)
Селектор пути позволяет легко выбрать объект по родительским/дочерним ссылкам, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/дочернего элемента для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделены косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемая строка, предоставляемая Amazon Cloud Directory. При создании объектов система предоставляет вам идентификатор созданного объекта. Идентификатор объекта неизменяем, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Чтобы идентифицировать объект с помощью ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект по пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
FilterAttributeRanges -> (список)
Предоставляет фильтры диапазонов для нескольких атрибутов. При предоставлении диапазонов для выбора типизированных ссылок любые неточные диапазоны должны быть указаны в конце. Любые атрибуты, для которых не указан диапазон, предполагаются соответствующими всему диапазону.
(структура)
Идентифицирует диапазон атрибутов, используемых заданным фильтром.
AttributeName -> (строка)
Range -> (структура)
Диапазон значений атрибутов, которые выбираются.
StartMode -> (строка)
StartValue -> (структура)
Значение, с которого начинается диапазон.
StringValue -> (строка)
BinaryValue -> (двоичные данные)
BooleanValue -> (булево)
NumberValue -> (строка)
DatetimeValue -> (метка времени)
EndMode -> (строка)
EndValue -> (структура)
Значение атрибута, по которому завершается диапазон.
StringValue -> (строка)
BinaryValue -> (двоичные данные)
BooleanValue -> (булево)
NumberValue -> (строка)
DatetimeValue -> (метка времени)
FilterTypedLink -> (структура)
Фильтры интерпретируются в порядке определения атрибутов в фасете типизированной ссылки, а не в порядке, в котором они предоставляются вызовам API.
SchemaArn -> (строка)
TypedLinkName -> (строка)
NextToken -> (строка)
MaxResults -> (целое число)
ListIncomingTypedLinks -> (структура)
Возвращает постраничный список всей входящей информации TypedLinkSpecifier для объекта. Также поддерживает фильтрацию по типу ссылки и атрибутам идентификации. Дополнительную информацию см. в разделе Типовые ссылки .
ObjectReference -> (структура)
Ссылка, идентифицирующая объект, атрибуты которого будут перечислены.
Selector -> (строка)
Селектор пути упрощает выбор объекта по ссылкам родитель/потомок, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/потомок для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделяются косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменен, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Для идентификации объекта с ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект на основе пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
FilterAttributeRanges -> (список)
Предоставляет фильтры диапазонов для нескольких атрибутов. При предоставлении диапазонов для выбора типовых ссылок все неточные диапазоны должны быть указаны в конце. Все атрибуты, для которых не указан диапазон, предполагаются соответствующими всему диапазону.
(структура)
Идентифицирует диапазон атрибутов, используемых указанным фильтром.
AttributeName -> (строка)
Range -> (структура)
Диапазон значений атрибутов, которые выбираются.
StartMode -> (строка)
StartValue -> (структура)
Значение, с которого начинается диапазон.
StringValue -> (строка)
BinaryValue -> (байтовый массив)
BooleanValue -> (логическое значение)
NumberValue -> (строка)
DatetimeValue -> (метка времени)
EndMode -> (строка)
EndValue -> (структура)
Значение атрибута для завершения диапазона.
StringValue -> (строка)
BinaryValue -> (байтовый массив)
BooleanValue -> (логическое значение)
NumberValue -> (строка)
DatetimeValue -> (метка времени)
FilterTypedLink -> (структура)
Фильтры интерпретируются в порядке атрибутов на фасете типовой ссылки, а не в порядке их предоставления в API-вызовах.
SchemaArn -> (строка)
TypedLinkName -> (строка)
NextToken -> (строка)
MaxResults -> (целое число)
GetLinkAttributes -> (структура)
Извлекает атрибуты, связанные с типовой ссылкой.
TypedLinkSpecifier -> (структура)
Разрешает прием типового указателя ссылки в качестве входных данных.
TypedLinkFacet -> (структура)
Идентифицирует фасет типовой ссылки, связанный с типовой ссылкой.
SchemaArn -> (строка)
TypedLinkName -> (строка)
SourceObjectReference -> (структура)
Идентифицирует исходный объект, к которому будет прикреплена типовая ссылка.
Selector -> (строка)
Селектор пути упрощает выбор объекта по ссылкам родитель/потомок, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/потомок для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделяются косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменен, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Для идентификации объекта с ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект на основе пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
TargetObjectReference -> (структура)
Идентифицирует целевой объект, к которому будет прикреплена типовая ссылка.
Selector -> (строка)
Селектор пути упрощает выбор объекта по ссылкам родитель/потомок, ведущим к нему от корня каталога. Используйте имена ссылок каждого родительского/потомок для построения пути. Селекторы пути начинаются с косой черты (/) и имена ссылок разделяются косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — это нечитаемый строковый идентификатор, предоставленный Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменен, и никакие два объекта не будут иметь одинаковый идентификатор объекта. Для идентификации объекта с ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект на основе пути
- #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки
IdentityAttributeValues -> (список)
Идентифицирует значение атрибута для обновления.
(структура)
Идентифицирует имя и значение атрибута для типовой ссылки.
AttributeName -> (строка)
Value -> (структура)
Значение для типовой ссылки.
StringValue -> (строка)
BinaryValue -> (байтовый массив)
BooleanValue -> (логическое значение)
NumberValue -> (строка)
DatetimeValue -> (метка времени)
AttributeNames -> (список)
Список имен атрибутов, значения которых будут извлечены.
(строка)
JSON Синтаксис:
[
{
"ListObjectAttributes": {
"ObjectReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer,
"FacetFilter": {
"SchemaArn": "string",
"FacetName": "string"
}
},
"ListObjectChildren": {
"ObjectReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"ListAttachedIndices": {
"TargetReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"ListObjectParentPaths": {
"ObjectReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"GetObjectInformation": {
"ObjectReference": {
"Selector": "string"
}
},
"GetObjectAttributes": {
"ObjectReference": {
"Selector": "string"
},
"SchemaFacet": {
"SchemaArn": "string",
"FacetName": "string"
},
"AttributeNames": ["string", ...]
},
"ListObjectParents": {
"ObjectReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"ListObjectPolicies": {
"ObjectReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"ListPolicyAttachments": {
"PolicyReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"LookupPolicy": {
"ObjectReference": {
"Selector": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"ListIndex": {
"RangesOnIndexedValues": [
{
"AttributeKey": {
"SchemaArn": "string",
"FacetName": "string",
"Name": "string"
},
"Range": {
"StartMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
"StartValue": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
},
"EndMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
"EndValue": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
}
}
}
...
],
"IndexReference": {
"Selector": "string"
},
"MaxResults": integer,
"NextToken": "string"
},
"ListOutgoingTypedLinks": {
"ObjectReference": {
"Selector": "string"
},
"FilterAttributeRanges": [
{
"AttributeName": "string",
"Range": {
"StartMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
"StartValue": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
},
"EndMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
"EndValue": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
}
}
}
...
],
"FilterTypedLink": {
"SchemaArn": "string",
"TypedLinkName": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"ListIncomingTypedLinks": {
"ObjectReference": {
"Selector": "string"
},
"FilterAttributeRanges": [
{
"AttributeName": "string",
"Range": {
"StartMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
"StartValue": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
},
"EndMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
"EndValue": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
}
}
}
...
],
"FilterTypedLink": {
"SchemaArn": "string",
"TypedLinkName": "string"
},
"NextToken": "string",
"MaxResults": integer
},
"GetLinkAttributes": {
"TypedLinkSpecifier": {
"TypedLinkFacet": {
"SchemaArn": "string",
"TypedLinkName": "string"
},
"SourceObjectReference": {
"Selector": "string"
},
"TargetObjectReference": {
"Selector": "string"
},
"IdentityAttributeValues": [
{
"AttributeName": "string",
"Value": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
}
}
...
]
},
"AttributeNames": ["string", ...]
}
}
...
]
--consistency-level (строка)
Представляет способ и время, в котором успешное запись или обновление объекта отражается в последующей операции чтения того же объекта.
Возможные значения:
SERIALIZABLEEVENTUAL
--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 (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-auto-prompt (boolean)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запрошение параметров ввода CLI.
Вывод
Ответы -> (список)
Список всех ответов для каждой пакетной операции чтения.
(структура)
Представляет вывод операции ответа BatchRead.
УспешныйОтвет -> (структура)
Указывает, какая операция в пакете выполнена успешно.
СписокАтрибутовОбъекта -> (структура)
Список всех атрибутов, связанных с объектом.
Атрибуты -> (список)
Карта атрибутов, связанная с объектом. AttributeArn — ключ; значение атрибута — значение.
(структура)
Сочетание ключа и значения атрибута.
Ключ -> (структура)
Ключ атрибута.
SchemaArn -> (строка)
FacetName -> (строка)
Имя -> (строка)
Значение -> (структура)
Значение атрибута.
СтроковоеЗначение -> (строка)
ДвоичноеЗначение -> (двоичные данные)
ЛогическоеЗначение -> (логическое значение)
ЧисловоеЗначение -> (строка)
ЗначениеДатыИВремени -> (отметка времени)
NextToken -> (строка)
СписокДочернихОбъектов -> (структура)
Возвращает отсортированный по страницам список дочерних объектов, связанных с заданным объектом.
ДочерниеОбъекты -> (карта)
Структура дочерних объектов, которая представляет собой карту, где ключ — LinkName, а значение — ObjectIdentifier.
ключ -> (строка)
значение -> (строка)
NextToken -> (строка)
ПолучитьИнформацияОбОбъекте -> (структура)
Извлекает метаданные об объекте.
ГраниСхемы -> (список)
Грани, прикрепленные к указанному объекту.
(структура)
Грань.
SchemaArn -> (строка)
FacetName -> (строка)
ИдентификаторОбъекта -> (строка)
ObjectIdentifier указанного объекта.ПолучитьАтрибутыОбъекта -> (структура)
Извлекает атрибуты в рамках грани, связанные с объектом.
Атрибуты -> (список)
Значения атрибутов, связанные с объектом.
(структура)
Сочетание ключа и значения атрибута.
Ключ -> (структура)
Ключ атрибута.
SchemaArn -> (строка)
FacetName -> (строка)
Имя -> (строка)
Значение -> (структура)
Значение атрибута.
СтроковоеЗначение -> (строка)
ДвоичноеЗначение -> (двоичные данные)
ЛогическоеЗначение -> (логическое значение)
ЧисловоеЗначение -> (строка)
ЗначениеДатыИВремени -> (отметка времени)
СписокПрикрепленныхИндексов -> (структура)
Список индексов, прикрепленных к объекту.
ПрикрепленияИндексов -> (список)
Индексы, прикрепленные к указанному объекту.
(структура)
Представляет индекс и прикрепленный к нему объект.
ИндексированныеАтрибуты -> (список)
Индексированные значения атрибутов.
(структура)
Сочетание ключа и значения атрибута.
Ключ -> (структура)
Ключ атрибута.
SchemaArn -> (строка)
FacetName -> (строка)
Имя -> (строка)
Значение -> (структура)
Значение атрибута.
СтроковоеЗначение -> (строка)
ДвоичноеЗначение -> (двоичные данные)
ЛогическоеЗначение -> (логическое значение)
ЧисловоеЗначение -> (строка)
ЗначениеДатыИВремени -> (отметка времени)
ИдентификаторОбъекта -> (строка)
ObjectIdentifier прикрепленного к индексу объекта. В ответ на ListAttachedIndices, ObjectIdentifier индекса, прикрепленного к объекту. Это поле всегда содержит ObjectIdentifier объекта на противоположной стороне соединения, указанного в запросе.NextToken -> (строка)
СписокРодительскихПутейОбъекта -> (структура)
Возвращает все доступные родительские пути для любого типа объектов, таких как узлы, листья, узлы политик и узлы индексов. Дополнительную информацию об объектах см. в разделе Структура каталога.
СписокПутейИдентификаторовОбъектов -> (список)
Возвращает путь к ObjectIdentifiers, связанным с каталогом.
(структура)
Возвращает путь к ObjectIdentifiers, связанному с каталогом.
Путь -> (строка)
ИдентификаторыОбъектов -> (список)
Список ObjectIdentifiers, начиная с корня каталога до объекта в запросе.
(строка)
NextToken -> (строка)
СписокПолитикОбъекта -> (структура)
Возвращает прикрепленные к объекту политики в режиме пагинации.
ПрикрепленныеИдентификаторыПолитик -> (список)
Список идентификаторов политик ObjectIdentifiers, прикрепленных к объекту.
(строка)
NextToken -> (строка)
СписокПрикрепленийПолитик -> (структура)
Возвращает все ObjectIdentifiers, к которым прикреплена данная политика.
ИдентификаторыОбъектов -> (список)
Список ObjectIdentifiers, к которым прикреплена политика.
(строка)
NextToken -> (строка)
ПоискПолитики -> (структура)
Перечисляет все политики от корня каталога до указанного объекта. Если политики отсутствуют, возвращается пустой список. Если политики присутствуют и некоторые объекты не имеют прикрепленных политик, возвращаются ObjectIdentifier для таких объектов. При наличии политик возвращаются ObjectIdentifier, policyId и policyType. Пути, не ведущие к корню из целевого объекта, игнорируются. Дополнительную информацию см. в разделе Политики.
СписокПутейПолитик -> (список)
Предоставляет список путей к политикам. Политики содержат PolicyId, ObjectIdentifier и PolicyType. Дополнительную информацию см. в разделе Политики.
(структура)
Используется, когда в каталоге существует обычный объект, и вы хотите найти все политики, связанные с этим объектом и его родителями.
Путь -> (строка)
Политики -> (список)
Список объектов политик.
(структура)
Содержит PolicyType, PolicyId и ObjectIdentifier, к которому она прикреплена. Дополнительную информацию см. в разделе Политики.
ИдентификаторПолитики -> (строка)
PolicyAttachment.ИдентификаторОбъекта -> (строка)
ObjectIdentifier, связанный с PolicyAttachment.ТипПолитики -> (строка)
PolicyAttachment.NextToken -> (строка)
СписокИндексов -> (структура)
Перечисляет объекты, прикрепленные к указанному индексу.
ПрикрепленияИндексов -> (список)
Объекты и индексированные значения, прикрепленные к индексу.
(структура)
Представляет индекс и прикрепленный к нему объект.
ИндексированныеАтрибуты -> (список)
Индексированные значения атрибутов.
(структура)
Сочетание ключа и значения атрибута.
Ключ -> (структура)
Ключ атрибута.
SchemaArn -> (строка)
FacetName -> (строка)
Имя -> (строка)
Значение -> (структура)
Значение атрибута.
СтроковоеЗначение -> (строка)
ДвоичноеЗначение -> (двоичные данные)
ЛогическоеЗначение -> (логическое значение)
ЧисловоеЗначение -> (строка)
ЗначениеДатыИВремени -> (отметка времени)
ИдентификаторОбъекта -> (строка)
ObjectIdentifier прикрепленного к индексу объекта. В ответ на ListAttachedIndices, ObjectIdentifier индекса, прикрепленного к объекту. Это поле всегда содержит ObjectIdentifier объекта на противоположной стороне соединения, указанного в запросе.NextToken -> (строка)
СписокВыходныхСвязейТипов -> (структура)
Возвращает список всех исходящих данных TypedLinkSpecifier для объекта с разбивкой по страницам. Он также поддерживает фильтрацию по типизированному соединению и атрибутам идентификации. Для получения дополнительной информации см. Typed Links .
TypedLinkSpecifiers -> (list)
Возвращает спецификатор типизированной ссылки в качестве выходных данных.
(structure)
Содержит всю информацию, которая используется для уникальной идентификации типизированной ссылки. Параметры, обсуждаемые в этом разделе, используются для однозначного указания типизированной ссылки, с которой выполняется операция. API AttachTypedLink возвращает спецификатор типизированной ссылки, а API DetachTypedLink принимает его в качестве входных данных. Аналогичным образом, операции API ListIncomingTypedLinks и ListOutgoingTypedLinks предоставляют спецификаторы типизированной ссылки в качестве выходных данных. Вы также можете создать спецификатор типизированной ссылки с нуля.
TypedLinkFacet -> (structure)
Определяет типизированный линк-фасет, связанный с типизированной ссылкой.
SchemaArn -> (string)
TypedLinkName -> (string)
SourceObjectReference -> (structure)
Определяет исходный объект, к которому будет присоединена типизированная ссылка.
Selector -> (string)
Селектор пути поддерживает простой выбор объекта по ссылкам родитель/дочерний, ведущим к нему от корня каталога. Используйте имена ссылок из каждой ссылки родитель/дочерний для построения пути. Селекторы пути начинаются со знака косой черты (/) и имена ссылок разделяются косыми чертами. Для получения дополнительной информации о путях см. Access Objects . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — непрозрачная строка, предоставленная Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменен, и никакие два объекта никогда не будут иметь один и тот же идентификатор объекта. Чтобы идентифицировать объект с ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект на основе пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
TargetObjectReference -> (structure)
Определяет целевой объект, к которому будет присоединена типизированная ссылка.
Selector -> (string)
Селектор пути поддерживает простой выбор объекта по ссылкам родитель/дочерний, ведущим к нему от корня каталога. Используйте имена ссылок из каждой ссылки родитель/дочерний для построения пути. Селекторы пути начинаются со знака косой черты (/) и имена ссылок разделяются косыми чертами. Для получения дополнительной информации о путях см. Access Objects . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — непрозрачная строка, предоставленная Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменен, и никакие два объекта никогда не будут иметь один и тот же идентификатор объекта. Чтобы идентифицировать объект с ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект на основе пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
IdentityAttributeValues -> (list)
Определяет значение атрибута для обновления.
(structure)
Определяет имя и значение атрибута для типизированной ссылки.
AttributeName -> (string)
Value -> (structure)
Значение для типизированной ссылки.
StringValue -> (string)
BinaryValue -> (blob)
BooleanValue -> (boolean)
NumberValue -> (string)
DatetimeValue -> (timestamp)
NextToken -> (string)
ListIncomingTypedLinks -> (structure)
Возвращает список всех входящих данных TypedLinkSpecifier для объекта с разбивкой по страницам. Он также поддерживает фильтрацию по типизированному соединению и атрибутам идентификации. Для получения дополнительной информации см. Typed Links .
LinkSpecifiers -> (list)
Возвращает один или несколько спецификаторов типизированной ссылки в качестве выходных данных.
(structure)
Содержит всю информацию, которая используется для уникальной идентификации типизированной ссылки. Параметры, обсуждаемые в этом разделе, используются для однозначного указания типизированной ссылки, с которой выполняется операция. API AttachTypedLink возвращает спецификатор типизированной ссылки, а API DetachTypedLink принимает его в качестве входных данных. Аналогичным образом, операции API ListIncomingTypedLinks и ListOutgoingTypedLinks предоставляют спецификаторы типизированной ссылки в качестве выходных данных. Вы также можете создать спецификатор типизированной ссылки с нуля.
TypedLinkFacet -> (structure)
Определяет типизированный линк-фасет, связанный с типизированной ссылкой.
SchemaArn -> (string)
TypedLinkName -> (string)
SourceObjectReference -> (structure)
Определяет исходный объект, к которому будет присоединена типизированная ссылка.
Selector -> (string)
Селектор пути поддерживает простой выбор объекта по ссылкам родитель/дочерний, ведущим к нему от корня каталога. Используйте имена ссылок из каждой ссылки родитель/дочерний для построения пути. Селекторы пути начинаются со знака косой черты (/) и имена ссылок разделяются косыми чертами. Для получения дополнительной информации о путях см. Access Objects . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — непрозрачная строка, предоставленная Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменен, и никакие два объекта никогда не будут иметь один и тот же идентификатор объекта. Чтобы идентифицировать объект с ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект на основе пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
TargetObjectReference -> (structure)
Определяет целевой объект, к которому будет присоединена типизированная ссылка.
Selector -> (string)
Селектор пути поддерживает простой выбор объекта по ссылкам родитель/дочерний, ведущим к нему от корня каталога. Используйте имена ссылок из каждой ссылки родитель/дочерний для построения пути. Селекторы пути начинаются со знака косой черты (/) и имена ссылок разделяются косыми чертами. Для получения дополнительной информации о путях см. Access Objects . Вы можете идентифицировать объект одним из следующих способов:
- $ObjectIdentifier - Идентификатор объекта — непрозрачная строка, предоставленная Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменен, и никакие два объекта никогда не будут иметь один и тот же идентификатор объекта. Чтобы идентифицировать объект с ObjectIdentifier, ObjectIdentifier должен быть заключен в двойные кавычки.
- /some/path - Идентифицирует объект на основе пути
- #SomeBatchReference - Идентифицирует объект в пакетном вызове
IdentityAttributeValues -> (list)
Определяет значение атрибута для обновления.
(structure)
Определяет имя и значение атрибута для типизированной ссылки.
AttributeName -> (string)
Value -> (structure)
Значение для типизированной ссылки.
StringValue -> (string)
BinaryValue -> (blob)
BooleanValue -> (boolean)
NumberValue -> (string)
DatetimeValue -> (timestamp)
NextToken -> (string)
GetLinkAttributes -> (structure)
Список атрибутов для получения из типизированной ссылки.
Attributes -> (list)
Атрибуты, связанные с типизированной ссылкой.
(structure)
Комбинация ключа и значения атрибута.
Key -> (structure)
Ключ атрибута.
SchemaArn -> (string)
FacetName -> (string)
Name -> (string)
Value -> (structure)
Значение атрибута.
StringValue -> (string)
BinaryValue -> (blob)
BooleanValue -> (boolean)
NumberValue -> (string)
DatetimeValue -> (timestamp)
ListObjectParents -> (structure)
Список родительских объектов для получения.
ParentLinks -> (list)
Возвращает список родительских ссылок и кортежей LinkName.
(structure)
Пара ObjectIdentifier и LinkName.
ObjectIdentifier -> (string)
LinkName -> (string)
NextToken -> (string)
ExceptionResponse -> (structure)
Определяет, какая операция в пакете завершилась неудачей.
Type -> (string)
InvalidArnException .Message -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.