list-access-grants

Описание

Возвращает список грантов доступа в вашем экземпляре S3 Access Grants.

Разрешения

Для использования этой операции необходимо разрешение s3:ListAccessGrants.

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

Сводка

  list-access-grants
--account-id <value>
[--next-token <value>]
[--max-results <value>]
[--grantee-type <value>]
[--grantee-identifier <value>]
[--permission <value>]
[--grant-scope <value>]
[--application-arn <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]

Опции

--account-id (string)

Идентификатор учетной записи Amazon Web Services экземпляра S3 Access Grants.

--next-token (string)

Токен разбиения на страницы для запроса следующей страницы результатов. Передайте это значение в последующем запросе List Access Grants для получения следующей страницы результатов.

--max-results (integer)

Максимальное количество грантов доступа, которые вы хотите получить в ответе List Access Grants. Если результаты включают токен разбиения на страницы NextToken, сделайте еще один вызов, используя NextToken, чтобы определить, есть ли больше результатов.

--grantee-type (string)

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

IAM - IAM user or role.
DIRECTORY_USER - Пользователь вашей корпоративной директории. Вы можете использовать этот параметр, если добавили свою корпоративную директорию удостоверений в IAM Identity Center и связали экземпляр IAM Identity Center с экземпляром S3 Access Grants.
DIRECTORY_GROUP - Группа вашей корпоративной директории. Вы можете использовать этот параметр, если добавили свою корпоративную директорию удостоверений в IAM Identity Center и связали экземпляр IAM Identity Center с экземпляром S3 Access Grants.

Возможные значения:

DIRECTORY_USER
DIRECTORY_GROUP
IAM

--grantee-identifier (string)

Уникальный идентификатор Grantee. Если тип получателя — IAM, идентификатор — это Amazon Resource Name (ARN) IAM пользователя или роли. Если тип получателя — пользователь или группа директории, идентификатор — 128-битный универсально уникальный идентификатор (UUID) в формате a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. Вы можете получить этот UUID из своего экземпляра Amazon Web Services IAM Identity Center.

--permission (string)

Тип разрешения, предоставленного вашим данным S3, которое можно установить в одно из следующих значений:

READ – Предоставить доступ только для чтения к данным S3.
WRITE – Предоставить доступ только для записи к данным S3.
READWRITE – Предоставить доступ как для чтения, так и для записи к данным S3.

Возможные значения:

READ
WRITE
READWRITE

--grant-scope (string)

Путь S3 к данным, к которым вы предоставляете доступ. Это результат добавления Subprefix к области действия местоположения.

--application-arn (string)

Имя ресурса Amazon (ARN) приложения Amazon Web Services IAM Identity Center, связанного с вашим экземпляром Identity Center. Если грант включает ARN приложения, получатель может получить доступ к данным S3 только через это приложение.

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное JSON, поскольку строка будет воспринята буквально. Это может не указываться вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит 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)

Регион для использования. Переопределяет настройки config/env.

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Пакет сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки config/env.

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

Output

NextToken -> (string)

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.

AccessGrantsList -> (list)

A container for a list of grants in an S3 Access Grants instance.

(structure)

Information about the access grant.

CreatedAt -> (timestamp)

The date and time when you created the S3 Access Grants instance.

AccessGrantId -> (string)

The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

AccessGrantArn -> (string)

The Amazon Resource Name (ARN) of the access grant.

Grantee -> (structure)

The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added your corporate directory to Amazon Web Services IAM Identity Center and associated your Identity Center instance with your S3 Access Grants instance, the grantee can also be a corporate directory user or group.

GranteeType -> (string)

The type of the grantee to which access has been granted. It can be one of the following values:

IAM - An IAM user or role.
DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.
DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

GranteeIdentifier -> (string)

The unique identifier of the Grantee . If the grantee type is IAM , the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 . You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

Permission -> (string)

The type of access granted to your S3 data, which can be set to one of the following values:

READ – Grant read-only access to the S3 data.
WRITE – Grant write-only access to the S3 data.
READWRITE – Grant both read and write access to the S3 data.

AccessGrantsLocationId -> (string)

The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

AccessGrantsLocationConfiguration -> (structure)

The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

S3SubPrefix -> (string)

The S3SubPrefix is appended to the location scope creating the grant scope. Use this field to narrow the scope of the grant to a subset of the location scope. This field is required if the location scope is the default location s3:// because you cannot create a grant for all of your S3 data in the Region and must narrow the scope. For example, if the location scope is the default location s3:// , the S3SubPrefx can be a <bucket-name>/*, so the full grant scope path would be s3://<bucket-name>/* . Or the S3SubPrefx can be <bucket-name>/<prefix-name>* , so the full grant scope path would be or s3://<bucket-name>/<prefix-name>* .

If the S3SubPrefix includes a prefix, append the wildcard character * after the prefix to indicate that you want to include all object key names in the bucket that start with that prefix.

GrantScope -> (string)

The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

ApplicationArn -> (string)

The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.