Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

start-attached-file-upload

Описание

Предоставляет подписанный URL Amazon S3 для загрузки вашего содержимого.

Предупреждение

Вы можете использовать этот API только для загрузки вложений в случай Amazon Connect Case или Amazon Connect Email.

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

Синтаксис

  start-attached-file-upload
[--client-token <value>]
--instance-id <value>
--file-name <value>
--file-size-in-bytes <value>
[--url-expiry-in-seconds <value>]
--file-use-case-type <value>
--associated-resource-arn <value>
[--created-by <value>]
[--tags <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]

Параметры

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

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указано, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в статье Making retries safe with idempotent APIs.

--instance-id (строка)

Уникальный идентификатор экземпляра Amazon Connect.

--file-name (строка)

Имя вложения, которое загружается.

--file-size-in-bytes (целое число)

Размер вложения в байтах.

--url-expiry-in-seconds (целое число)

Необязательное переопределение срока действия подписанного URL S3 в секундах. Значение по умолчанию — 300.

--file-use-case-type (строка)

Случай использования файла.

Предупреждение

Поддерживаются только ATTACHMENTS.

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

  • EMAIL_MESSAGE
  • ATTACHMENT

--associated-resource-arn (строка)

Ресурс, в который загружается вложение. Поддерживаются ресурсы Cases и Email.

Примечание

Это значение должно быть допустимым ARN.

--created-by (структура помеченных объединений)

Представляет личность, создавшую файл.

Примечание

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

ConnectUserArn -> (строка)

ARN агента, представляющего пользователя connect.

AWSIdentityArn -> (строка)

ARN STS или IAM, представляющий личность вызывающего API. Пользователи SDK не могут заполнить это поле, и это значение вычисляется автоматически, если ConnectUserArn не указано.

Сокращенный синтаксис:

ConnectUserArn=string,AWSIdentityArn=string

Синтаксис JSON:

{
  "ConnectUserArn": "string",
  "AWSIdentityArn": "string"
}

--tags (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу. Например, { "Tags": {"key1":"value1", "key2":"value2"} }.

key -> (строка)

value -> (строка)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

Переопределить 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 для вывода.

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

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

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

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

Вывод

FileArn -> (строка)

Уникальный идентификатор ресурса вложения (ARN).

FileId -> (строка)

Уникальный идентификатор ресурса вложения.

CreationTime -> (строка)

Время создания ресурса файла в виде временной метки ISO. Она указана в формате ISO 8601: yyyy-MM-ddThh:mm:ss.SSSZ . Например, 2024-05-03T02:41:28.172Z.

FileStatus -> (строка)

Текущее состояние вложения.

CreatedBy -> (структура помеченных объединений)

Представляет личность, создавшую файл.

Примечание

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

ConnectUserArn -> (строка)

ARN агента, представляющего пользователя connect.

AWSIdentityArn -> (строка)

ARN STS или IAM, представляющий личность вызывающего API. Пользователи SDK не могут заполнить это поле, и это значение вычисляется автоматически, если ConnectUserArn не указано.

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

Заголовки, которые должны быть предоставлены при загрузке файла в URL.

Url -> (строка)

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

UrlExpiry -> (строка)

Время истечения срока действия URL в временной метке ISO. Она указана в формате ISO 8601: yyyy-MM-ddThh:mm:ss.SSSZ . Например, 2019-11-08T02:41:28.172Z.

HeadersToInclude -> (карта)

Карта заголовков, которые следует предоставить при загрузке вложения.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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