describe-smb-file-shares

Описание

Получает описание одного или нескольких сетевых ресурсов SMB (Server Message Block) с общим доступом к файлам из S3 File Gateway. Данная операция поддерживается только для S3 File Gateway.

См. также: AWS API Documentation

Синтаксис

  describe-smb-file-shares
--file-share-arn-list <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]

Параметры

--file-share-arn-list (список)

Массив, содержащий Amazon Resource Name (ARN) каждого ресурса общего доступа к файлам, описание которого необходимо получить.

(строка)

Amazon Resource Name (ARN) ресурса общего доступа к файлам.

Синтаксис:

"string" "string" ...

--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 (строка)

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

--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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

SMBFileShareInfoList -> (список)

Массив, содержащий описание каждого запрошенного общего доступа к файлам.

(структура)

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

FileShareARN -> (строка)

Идентификатор ресурса Amazon (ARN) общего доступа к файлам.

FileShareId -> (строка)

Идентификатор общего доступа к файлам.

FileShareStatus -> (строка)

Статус общего доступа к файлам.

Допустимые значения: CREATING | UPDATING | AVAILABLE | DELETING

GatewayARN -> (строка)

Идентификатор ресурса Amazon (ARN) шлюза. Используйте операцию ListGateways, чтобы получить список шлюзов для вашей учетной записи и региона Amazon Web Services.

EncryptionType -> (строка)

Значение, определяющее тип шифрования на стороне сервера, который будет использоваться общим доступом к файлам для данных, хранящихся в Amazon S3.

Примечание

Рекомендуется использовать EncryptionType вместо KMSEncrypted для настройки метода шифрования общего доступа к файлам. Вам не нужно указывать значения для обоих параметров.

Если значения обоих параметров присутствуют в одном запросе, указанные методы шифрования не должны противоречить друг другу. Например, если EncryptionType равен SseS3, то KMSEncrypted должен быть равен false. Если EncryptionType равен SseKms или DsseKms, то KMSEncrypted должен быть равен true.

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

Необязательно. Установите значение true, чтобы использовать шифрование Amazon S3 на стороне сервера с вашим собственным ключом KMS (SSE-KMS), или false, чтобы использовать ключ, управляемый Amazon S3 (SSE-S3). Для использования двухслойного шифрования (DSSE-KMS) установите параметр EncryptionType вместо него.

Примечание

Допустимые значения: true | false

KMSKey -> (строка)

Необязательно. Идентификатор ресурса Amazon (ARN) симметричного ключа шифрования (CMK) клиента, используемого для шифрования на стороне сервера Amazon S3. Storage Gateway не поддерживает асимметричные CMK. Это значение должно быть установлено, если KMSEncrypted равно true, или если EncryptionType равно SseKms или DsseKms.

Path -> (строка)

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

Role -> (строка)

ARN роли IAM, которую шлюз файлов S3 принимает, когда он получает доступ к базовому хранилищу.

LocationARN -> (строка)

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

Примечание

Вы можете указать LocationARN в виде ARN ведра, ARN точки доступа или псевдонима точки доступа, как показано в следующих примерах.

ARN ведра:

arn:aws:s3:::amzn-s3-demo-bucket/prefix/

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

arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/

Если вы указываете точку доступа, политика ведра должна быть настроена на делегирование управления доступом к точке доступа. Дополнительная информация приведена в разделе Делегирование управления доступом к точкам доступа в Руководстве пользователя Amazon S3.

Псевдоним точки доступа:

test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

DefaultStorageClass -> (строка)

Класс хранения по умолчанию для объектов, размещаемых в ведре Amazon S3 шлюзом файлов S3. Значение по умолчанию равно S3_STANDARD. Необязательно.

Допустимые значения: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

ObjectACL -> (строка)

Значение, устанавливающее права доступа к списку управления доступом (ACL) для объектов в ведре S3, в которое шлюз файлов S3 помещает объекты. Значение по умолчанию равно private.

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

Значение, устанавливающее режим записи для общего доступа к файлам. Установите это значение в true, чтобы установить режим записи в чтение-только, в противном случае установите в false.

Допустимые значения: true | false

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

Значение, которое включает угадывание типа MIME для загружаемых объектов на основе расширений файлов. Установите это значение в true, чтобы включить угадывание типа MIME, в противном случае установите в false. Значение по умолчанию равно true.

Допустимые значения: true | false

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

Значение, которое задает, кто оплачивает стоимость запроса и стоимость загрузки данных из ведра S3. Если это значение установлено в true, запрос оплачивает запрашивающий; в противном случае, владелец ведра S3 оплачивает. Однако владелец ведра S3 всегда оплачивает стоимость хранения данных.

Примечание

RequesterPays — это настройка для ведра S3, которое поддерживает общий доступ к файлам, поэтому убедитесь, что конфигурация общего доступа к файлам совпадает с конфигурацией ведра S3.

Допустимые значения: true | false

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

Если это значение установлено в true, это означает, что список управления доступом (ACL) включён для общего доступа к файлам SMB. Если оно установлено в false, это означает, что права доступа к файлам и каталогам сопоставлены с правами доступа POSIX.

Дополнительная информация приведена в разделе Использование списков управления доступом Windows для ограничения доступа к общему доступу к файлам SMB в Руководстве пользователя Amazon S3 File Gateway.

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

Указывает, включён ли AccessBasedEnumeration.

AdminUserList -> (список)

Список пользователей или групп в Active Directory, имеющих права администратора на общий доступ к файлам. Группа должна быть задана с префиксом @. Приемлемые форматы включают: DOMAIN\User1, user1, @group1 и @DOMAIN\group1. Может быть установлен только в том случае, если параметр Authentication установлен в ActiveDirectory.

(строка)

ValidUserList -> (список)

Список пользователей или групп в Active Directory, которым разрешен доступ к общему доступу к файлам. Группа должна быть задана с префиксом @. Приемлемые форматы включают: DOMAIN\User1, user1, @group1 и @DOMAIN\group1. Может быть установлен только в том случае, если параметр Authentication установлен в ActiveDirectory.

(строка)

InvalidUserList -> (список)

Список пользователей или групп в Active Directory, которым запрещен доступ к общему доступу к файлам. Группа должна быть задана с префиксом @. Приемлемые форматы включают: DOMAIN\User1, user1, @group1 и @DOMAIN\group1. Может быть установлен только в том случае, если параметр Authentication установлен в ActiveDirectory.

(строка)

AuditDestinationARN -> (строка)

Идентификатор ресурса Amazon (ARN) хранилища, используемого для журналов аудита.

Authentication -> (строка)

Метод аутентификации общего доступа к файлам. По умолчанию это ActiveDirectory.

Допустимые значения: ActiveDirectory | GuestAccess

CaseSensitivity -> (строка)

Регистрозависимость имени объекта в ведре Amazon S3. Для ClientSpecified клиент определяет регистрозависимость. Для CaseSensitive шлюз определяет регистрозависимость. Значение по умолчанию равно ClientSpecified.

Tags -> (список)

Список до 50 тегов, назначенных общему доступу к файлам SMB, отсортированным по имени ключа в алфавитном порядке. Каждый тег — это пара «ключ-значение». Для шлюза с более чем 10 назначенными тегами вы можете просмотреть все теги, используя операцию API ListTagsForResource.

(структура)

Пара «ключ-значение», которая помогает управлять, фильтровать и искать ваши ресурсы. Допустимые символы: буквы, пробелы и цифры, представимые в формате UTF-8, а также следующие символы: + - = . _ : /.

Key -> (строка)

Ключ тега. Ключ не может начинаться с aws:.

Value -> (строка)

Значение ключа тега.

FileShareName -> (строка)

Имя общего доступа к файлам. Необязательно.

Примечание

FileShareName должен быть установлен, если в LocationARN задано имя префикса S3 или используется точка доступа или псевдоним точки доступа.

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

Информация о кэшировании для общего доступа к файлам.

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

Обновляет кэш общего доступа к файлам с помощью Time To Live (TTL). TTL — это время, прошедшее с момента последнего обновления, после которого доступ к каталогу заставит шлюз файлов в первую очередь обновить содержимое этого каталога из ведра Amazon S3 или файловой системы Amazon FSx. Длительность TTL указана в секундах.

Допустимые значения: 0, от 300 до 2 592 000 секунд (от 5 минут до 30 дней)

NotificationPolicy -> (строка)

Политика уведомлений для общего доступа к файлам. SettlingTimeInSeconds управляет количеством секунд, которые нужно подождать после последнего момента, когда клиент записал в файл, прежде чем генерировать уведомление ObjectUploaded. Поскольку клиенты могут выполнять много мелких записей в файлы, лучше всего установить этот параметр как можно дольше, чтобы избежать генерации нескольких уведомлений для одного файла в короткий промежуток времени.

Примечание

SettlingTimeInSeconds не влияет на время загрузки объекта в Amazon S3, только на время отправки уведомления.

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

Следующий пример включает NotificationPolicy, при этом SettlingTimeInSeconds задано в 60.

{\"Upload\": {\"SettlingTimeInSeconds\": 60}}

Следующий пример отключает NotificationPolicy.

{}

VPCEndpointDNSName -> (строка)

Указывает имя DNS для точки входа VPC, которую общий доступ к файлам SMB использует для подключения к Amazon S3.

Примечание

Этот параметр необходим для общих доступов к файлам SMB, которые подключаются к Amazon S3 через точку входа VPC, точку доступа VPC или псевдоним точки доступа, указывающий на точку доступа VPC.

BucketRegion -> (строка)

Указывает регион S3-бакета, в котором SMB-общий ресурс хранит файлы.

Примечание

Этот параметр требуется для SMB-общих ресурсов, которые подключаются к Amazon S3 через точку доступа VPC, точку доступа VPC или псевдоним точки доступа, указывающий на точку доступа VPC.

OplocksEnabled -> (boolean)

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

Примечание

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

Допустимые значения: true | false

END_OF_DOCUMENT_MARKER