get-resources

Описание

Перечисляет информацию о наборе ресурсов Resource.

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

get-resources является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в постраничном ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: items

Синтаксис

  get-resources
--rest-api-id <value>
[--embed <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--rest-api-id (строка)

Строковый идентификатор связанного RestApi.

--embed (список)

Параметр запроса для извлечения указанных ресурсов, встроенных в ресурс Resources в ответе. Это значение параметра embed — список строк, разделенных запятыми. В настоящее время запрос поддерживает только извлечение встроенных ресурсов Method таким образом. Значение параметра запроса должно быть списком со значениями и содержать строку "methods". Например, GET /restapis/{restapi_id}/resources?embed=methods.

(строка)

Синтаксис:

"string" "string" ...

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

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

Токен, указывающий, где начать постраничный вывод. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения данных в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов, возвращаемых в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничность в Руководстве пользователя AWS Command Line Interface.

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

Для получения списка ресурсов для REST API

Команда:

aws apigateway get-resources --rest-api-id 1234123412

Вывод:

{
    "items": [
        {
            "path": "/resource/subresource",
            "resourceMethods": {
                "POST": {}
            },
            "id": "024ace",
            "pathPart": "subresource",
            "parentId": "ai5b02"
        }
    ]
}

Вывод

position -> (строка)

items -> (список)

Текущая страница элементов из этого набора.

(структура)

Представляет ресурс API.

id -> (строка)

Идентификатор ресурса.

parentId -> (строка)

Идентификатор родительского ресурса.

pathPart -> (строка)

Последний сегмент пути для этого ресурса.

path -> (строка)

Полный путь для этого ресурса.

resourceMethods -> (карта)

Получает метод ресурса API для заданного HTTP-глагола.

ключ -> (строка)

значение -> (структура)

Представляет интерфейс для клиента, с помощью которого клиент вызывает API для доступа к ресурсам бэкенда. Ресурс метода интегрирован с ресурсом интеграции. Оба состоят из запроса и одного или нескольких ответов. Запрос метода принимает входные данные клиента, которые передаются в бэкенд через запрос интеграции. Ответ метода возвращает вывод из бэкенда клиенту через ответ интеграции. Запрос метода представлен ресурсом Метод, тогда как запрос интеграции представлен ресурсом Интеграция. С другой стороны, ответ метода представлен ресурсом ОтветМетода, тогда как ответ интеграции представлен ресурсом ОтветИнтеграции.

httpMethod -> (строка)

HTTP-глагол метода.

authorizationType -> (строка)

Тип авторизации метода. Допустимые значения — NONE для открытого доступа, AWS_IAM для использования разрешений AWS IAM, CUSTOM для использования пользовательского авторизатора или COGNITO_USER_POOLS для использования пула пользователей Cognito.

authorizerId -> (строка)

Идентификатор авторизатора, используемого в этом методе. authorizationType должен быть CUSTOM.

apiKeyRequired -> (логическое)

Флаг булевого типа, указывающий, требуется ли для вызова этого метода действительный ApiKey.

requestValidatorId -> (строка)

Идентификатор RequestValidator для проверки запроса.

operationName -> (строка)

Дружественное для человека обозначение операции для метода. Например, можно назначить operationName ListPets для метода GET /pets в примере PetStore.

requestParameters -> (карта)

Карта ключ-значение, определяющая обязательные или необязательные параметры запроса метода, которые могут быть приняты API Gateway. Ключ — это имя параметра запроса метода, соответствующее шаблону method.request.{location}.{name}, где location — querystring, path или header, а name — действительное и уникальное имя параметра. Значение, связанное с ключом, представляет собой флаг булевого типа, указывающий, является ли параметр обязательным (true) или необязательным (false). Имена параметров запроса метода, определённые здесь, доступны в Интеграции для сопоставления с параметрами запроса интеграции или шаблонами.

ключ -> (строка)

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

requestModels -> (карта)

Карта ключ-значение, определяющая схемы данных, представленные ресурсами Модель (как сопоставленное значение) загрузок запроса для заданных типов содержимого (как ключ сопоставления).

ключ -> (строка)

значение -> (строка)

methodResponses -> (карта)

Получает ответ метода, связанный с заданным кодом HTTP-статуса.

ключ -> (строка)

значение -> (структура)

Представляет ответ метода для заданного кода HTTP-статуса, возвращаемый клиенту. Ответ метода передаётся из бэкенда через соответствующий ответ интеграции, который может быть преобразован с использованием шаблона сопоставления.

statusCode -> (строка)

Код статуса ответа метода.

responseParameters -> (карта)

Карта ключ-значение, определяющая обязательные или необязательные параметры ответа, которые API Gateway может вернуть вызывающей стороне. Ключ определяет заголовок ответа метода, а значение указывает, является ли связанный заголовок ответа метода обязательным. Выражение ключа должно соответствовать шаблону method.response.header.{name}, где name — действительное и уникальное имя заголовка. API Gateway передаёт определённые данные ответа интеграции в заголовки ответа метода, указанные здесь, в соответствии с заданным вами сопоставлением в ОтветеИнтеграции API. Передаваемые данные ответа интеграции включают заголовок ответа интеграции, выраженный в integration.response.header.{name}, статическое значение, заключённое в паре одинарных кавычек (например, 'application/json'), или выражение JSON из полезной нагрузки ответа бэкенда в виде integration.response.body.{JSON-expression}, где JSON-expression — действительное выражение JSON без префикса $).

ключ -> (строка)

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

responseModels -> (карта)

Определяет ресурсы Модель, используемые для типа содержимого ответа. Модели ответов представлены как карта ключ/значение, где тип содержимого — ключ, а имя модели — значение.

ключ -> (строка)

значение -> (строка)

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

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

type -> (строка)

Определяет тип интеграции API-метода. Допустимое значение — одно из следующих:

Для интеграций HTTP и HTTP-прокси, каждая интеграция может указывать протокол (http/https ), порт и путь. Поддерживаются стандартные порты 80 и 443, а также пользовательские порты выше 1024. Интеграция HTTP или HTTP-прокси с connectionType VPC_LINK называется частной интеграцией и использует VpcLink для подключения API Gateway к сетевому балансировщику VPC.

httpMethod -> (строка)

Определяет тип HTTP-метода интеграции. Для свойства Type, если вы укажете MOCK , это свойство является необязательным. Для интеграций Lambda необходимо установить метод интеграции в POST . Для всех других типов необходимо указать это свойство.

uri -> (строка)

Определяет универсальный идентификатор ресурса (URI) конечной точки интеграции.

Для HTTP или HTTP_PROXY интеграций URI должен быть полностью сформированным, закодированным URL HTTP(S) в соответствии со спецификацией RFC-3986 для стандартных интеграций. Если connectionType VPC_LINK укажите DNS-имя сетевого балансировщика. Для AWS или AWS_PROXY интеграций URI имеет вид arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Здесь {Region} — регион API Gateway (например, us-east-1); {service} — имя интегрированной Amazon Web Services-службы (например, s3); а {subdomain} — выделенный домен, поддерживаемый некоторыми Amazon Web Services-службами для быстрого поиска имени хоста. action может использоваться для API Amazon Web Services, основанного на действиях, используя строку запроса Action={name}&{p1}={v1}&p2={v2}… Следующее {service_api} относится к поддерживаемому действию {name} плюс все необходимые входные параметры. В качестве альтернативы можно использовать path для API Amazon Web Services, основанного на путях. Следующее {service_api} относится к пути к ресурсу Amazon Web Services-службы, включая регион интегрированной Amazon Web Services-службы, если применимо. Например, для интеграции с API S3 GetObject, uri может быть либо arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} , либо arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

connectionType -> (строка)

Тип сетевого подключения к конечной точке интеграции. Допустимое значение — INTERNET для подключений через публичную маршрутизируемую сеть Интернет или VPC_LINK для частных подключений между API Gateway и сетевым балансировщиком в VPC. Значение по умолчанию — INTERNET .

connectionId -> (строка)

Идентификатор VpcLink, используемый для интеграции, когда connectionType=VPC_LINK и неопределён, в противном случае.

credentials -> (строка)

Указывает необходимые учетные данные для интеграции, если таковые имеются. Для интеграций AWS доступны три варианта. Для указания роли IAM, которую должен принять API Gateway, используйте Amazon Resource Name (ARN) роли. Для требования передачи идентификатора вызывающего пользователя из запроса, укажите строку arn:aws:iam::\*:user/\* . Для использования разрешений на основе ресурсов для поддерживаемых Amazon Web Services-служб, укажите null.

requestParameters -> (карта)

Ключевое значение карты, определяющей параметры запроса, передаваемые из запроса метода на бэкенд. Ключ — имя параметра запроса интеграции, а связанное значение — значение параметра запроса метода или статическое значение, которое должно быть заключено в одинарные кавычки и предварительно закодировано в соответствии с требованиями бэкенда. Значение параметра запроса метода должно соответствовать шаблону method.request.{location}.{name} , где location querystring , path , или header и name должно быть действительным и уникальным именем параметра запроса метода.

key -> (строка)

value -> (строка)

requestTemplates -> (карта)

Представляет собой карту шаблонов Velocity, применяемых к полезной нагрузке запроса на основе значения заголовка Content-Type, отправленного клиентом. Значение типа содержимого — ключ в этой карте, а шаблон (как строка) — значение.

key -> (строка)

value -> (строка)

passthroughBehavior -> (строка)

Определяет, как тело запроса метода с неотображенным типом содержимого будет передаваться в запрос интеграции на бэкенд без преобразования. Тип содержимого считается неотображенным, если шаблон сопоставления не определен в интеграции или тип содержимого не соответствует ни одному из сопоставленных типов содержимого, как указано в requestTemplates . Допустимое значение — одно из следующих: WHEN_NO_MATCH : передает тело запроса метода в запрос интеграции на бэкенд без преобразования, когда тип содержимого запроса метода не соответствует ни одному из типов содержимого, связанных с шаблонами сопоставления, определенными в запросе интеграции. WHEN_NO_TEMPLATES : передает тело запроса метода в запрос интеграции на бэкенд без преобразования, когда в запросе интеграции не определен ни один шаблон сопоставления. Если шаблон определен при выборе этого параметра, запрос метода с неотображенным типом содержимого будет отклонен с ответом HTTP 415 Unsupported Media Type. NEVER : отклоняет запрос метода с ответом HTTP 415 Unsupported Media Type, когда либо тип содержимого запроса метода не соответствует ни одному из типов содержимого, связанных с шаблонами сопоставления, определенными в запросе интеграции, либо в запросе интеграции не определен ни один шаблон сопоставления.

contentHandling -> (строка)

Указывает, как обрабатывать преобразования типов содержимого полезной нагрузки запроса. Поддерживаемые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT со следующими особенностями:

Если это свойство не определено, полезная нагрузка запроса будет передаваться из запроса метода в запрос интеграции без изменений, при условии, что passthroughBehavior настроено на поддержку передачи полезной нагрузки.

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

Настраиваемый тайм-аут от 50 до 29000 миллисекунд. Значение по умолчанию — 29000 миллисекунд или 29 секунд.

cacheNamespace -> (строка)

Определяет группу взаимосвязанных кэшированных параметров. По умолчанию API Gateway использует идентификатор ресурса в качестве cacheNamespace . Можно указать тот же cacheNamespace для разных ресурсов, чтобы возвращать одинаковые кэшированные данные для запросов к различным ресурсам.

cacheKeyParameters -> (список)

Список параметров запроса, значения которых кэширует API Gateway. Чтобы быть допустимыми значениями для cacheKeyParameters , эти параметры также должны быть указаны для метода requestParameters .

(строка)

integrationResponses -> (карта)

Определяет ответы интеграции.

key -> (строка)

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

Представляет ответ интеграции. Код состояния должен соответствовать существующему MethodResponse, а параметры и шаблоны могут использоваться для преобразования ответа бэкенда.

statusCode -> (строка)

Указывает код состояния, используемый для сопоставления ответа интеграции с существующим MethodResponse.

selectionPattern -> (строка)

Определяет шаблон регулярных выражений (regex), используемый для выбора ответа интеграции на основе ответа от бэкенда. Например, если ответ об успехе ничего не возвращает, а ответ об ошибке возвращает какую-то строку, можно использовать regex .+ для соответствия ответу об ошибке. Однако, в таких случаях убедитесь, что ответ об ошибке не содержит символов новой строки (\n ). Если бэкендом является функция Lambda, сопоставляется заголовок ошибки Lambda-функции. Для всех других HTTP и Amazon Web Services-бэкендов, сопоставляется код HTTP-статуса.

responseParameters -> (карта)

Ключевая пара значений, определяющая параметры ответа, передаваемые в ответ метода от бэкенда. Ключ — имя параметра заголовка ответа метода, сопоставленное значение — значение заголовка ответа интеграции, статическое значение, заключенное в одинарные кавычки, или выражение JSON из тела ответа интеграции. Ключ сопоставления должен соответствовать шаблону method.response.header.{name} , где name — допустимое и уникальное имя заголовка. Сопоставленное нестатическое значение должно соответствовать шаблону integration.response.header.{name} или integration.response.body.{JSON-expression} , где name — допустимое и уникальное имя заголовка ответа, а JSON-expression — допустимое выражение JSON без префикса $.

key -> (строка)

value -> (строка)

responseTemplates -> (карта)

Определяет шаблоны, используемые для преобразования тела ответа интеграции. Шаблоны ответа представлены в виде карты ключ/значение, где тип содержимого — ключ, а шаблон — значение.

key -> (строка)

value -> (строка)

contentHandling -> (строка)

Указывает, как обрабатывать преобразования типов содержимого полезной нагрузки ответа. Поддерживаемые значения — CONVERT_TO_BINARY и CONVERT_TO_TEXT со следующими особенностями:

Если это свойство не определено, полезная нагрузка ответа будет передаваться из ответа интеграции в ответ метода без изменений.

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

Определяет конфигурацию TLS для интеграции.

insecureSkipVerification -> (булево)

Указывает, следует ли API Gateway пропускать проверку того, выдан сертификат для конечной точки интеграции авторизованным центром сертификации. Это не рекомендуется, но это позволяет использовать сертификаты, подписанные частными центрами сертификации или самоподписанные сертификаты. Если включено, API Gateway по-прежнему выполняет базовую проверку сертификата, которая включает проверку даты истечения срока действия сертификата, имени хоста и наличия корневого сертификата. Поддерживается только для HTTP и HTTP_PROXY интеграций.

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

Включение insecureSkipVerification не рекомендуется, особенно для интеграций с общедоступными HTTPS-конечными точками. Если включить insecureSkipVerification , вы увеличиваете риск атак «человек посередине».

authorizationScopes -> (список)

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

(строка)

END_OF_DOCUMENT_MARKER