Spec-Zone.ru › AWS CLI v2

[ aws . s3control ]

list-access-points

Описание

Примечание

Данная операция не поддерживается для ведер каталогов.

Возвращает список точек доступа, принадлежащих текущей учётной записи, связанной с указанным ведром. Вы можете получить до 1000 точек доступа за один вызов. Если указанное ведро содержит более 1000 точек доступа (или количество, указанное в maxResults, в зависимости от меньшего значения), ответ будет содержать маркер продолжения, который можно использовать для получения дополнительных точек доступа.

Все запросы Amazon S3 на Outposts REST API для этого действия требуют дополнительного параметра x-amz-outpost-id, который должен быть передан вместе с запросом. Кроме того, необходимо использовать префикс имени хоста конечной точки S3 на Outposts вместо s3-control. Пример синтаксиса запроса для Amazon S3 на Outposts, использующего префикс имени хоста конечной точки S3 на Outposts и x-amz-outpost-id, полученный с помощью ARN точки доступа, см. в разделе Примеры.

Следующие действия связаны с ListAccessPoints:

  • CreateAccessPoint
  • DeleteAccessPoint
  • GetAccessPoint

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

Синопсис

  list-access-points
--account-id <value>
[--bucket <value>]
[--next-token <value>]
[--max-results <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 (строка)

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

--bucket (строка)

Имя ведра, точки доступа к которому требуется получить.

Для использования этого параметра с Amazon S3 на Outposts с REST API необходимо также указать имя и x-amz-outpost-id.

Для использования этого параметра с S3 на Outposts с Amazon Web Services SDK и командной строкой необходимо указать ARN ведра, к которому осуществляется доступ, в формате arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name>. Например, чтобы получить доступ к ведру reports через Outpost my-outpost, принадлежащему учётной записи 123456789012 в регионе us-west-2, используйте URL-кодирование arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. Значение должно быть URL-кодировано.

--next-token (строка)

Маркер продолжения. Если предыдущий вызов ListAccessPoints вернул маркер продолжения в поле NextToken, то предоставление этого значения здесь заставляет Amazon S3 получить следующую страницу результатов.

--max-results (целое число)

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

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

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, выполняет валидацию входных данных команды и возвращает пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (логическое значение)

Включает отладку.

--endpoint-url (строка)

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

--no-verify-ssl (логическое значение)

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

--no-paginate (логическое значение)

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

--output (строка)

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

  • json
  • текст
  • таблица
  • yaml
  • yaml-потоковый

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (логическое значение)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображаемого как двоичный блок fileb://, всегда будет обрабатываться как двоичный, и будет использоваться содержимое файла непосредственно независимо от значения настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного значения cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод пейджера командной строки.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Пример 1: Получение списка всех точек доступа для учётной записи

Следующий пример отображает список всех точек доступа, прикреплённых к ведрам, принадлежащим учётной записи 123456789012.

list-access-points

Вывод:

aws s3control list-access-points \
    --account-id 123456789012

Пример 2: Получение списка всех точек доступа для ведра

Следующий пример получает список всех точек доступа, прикреплённых к ведру external-docs, принадлежащему учётной записи 123456789012.

aws s3control list-access-points \
    --account-id 123456789012 \
    --bucket external-docs

Вывод:

{
    "AccessPointList": [
        {
            "Name": "customer-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "external-docs"
        },
        {
            "Name": "public-ap",
            "NetworkOrigin": "Internet",
            "Bucket": "external-docs"
        }
    ]
}

Дополнительную информацию см. в разделе Управление доступом к данным с помощью точек доступа Amazon S3 в справочнике разработчика Amazon Simple Storage Service.

Вывод

AccessPointList -> (список)

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

(структура)

Точка доступа для доступа к ведру.

Name -> (строка)

Имя этой точки доступа.

NetworkOrigin -> (строка)

Указывает, разрешён ли доступ из открытого интернета для этой точки доступа. Если VpcConfiguration указан для этой точки доступа, то NetworkOrigin является VPC, и доступ из открытого интернета не разрешён. В противном случае, NetworkOrigin является Internet, и доступ из открытого интернета разрешён, при условии соблюдения политики доступа для точки доступа и ведра.

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

Конфигурация виртуальной частной сети (VPC) для этой точки доступа, если она существует.

Примечание

Это поле пусто, если эта точка доступа является точкой доступа Amazon S3 на Outposts, которая используется другими сервисами Amazon Web Services.

VpcId -> (строка)

Если это поле указано, эта точка доступа будет разрешать подключения только из указанного идентификатора VPC.

Bucket -> (строка)

Имя ведра, связанного с этой точкой доступа.

AccessPointArn -> (строка)

ARN точки доступа.

Alias -> (строка)

Имя или псевдоним точки доступа.

BucketAccountId -> (строка)

Идентификатор учётной записи Amazon Web Services, связанной с ведром S3, связанным с этой точкой доступа.

NextToken -> (строка)

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

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

Spec-Zone.ru

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