put-targets

Описание

Добавляет указанные целевые ресурсы к указальному правилу или обновляет целевые ресурсы, если они уже связаны с правилом.

Целевые ресурсы — это ресурсы, которые вызываются, когда правило запускается.

Максимальное количество записей на запрос составляет 10.

Список служб, которые можно настроить в качестве целевых ресурсов для событий, см. в разделе Целевые ресурсы EventBridge в * Руководстве пользователя Amazon EventBridge * .

Создание правил с встроенными целевыми ресурсами поддерживается только в Консоли управления Amazon Web Services. Встроенные целевые ресурсы:

• Amazon EBS CreateSnapshot API call
• Amazon EC2 RebootInstances API call
• Amazon EC2 StopInstances API call
• Amazon EC2 TerminateInstances API call

Для некоторых типов целевых ресурсов PutTargets предоставляет параметры, специфичные для целевого ресурса. Если целевой ресурс — поток данных Kinesis, вы можете указать, в какой фрагмент попадает событие, используя аргумент KinesisParameters. Чтобы вызвать команду на нескольких экземплярах EC2 с помощью одного правила, можно использовать поле RunCommandParameters.

Для возможности выполнения API-вызовов к ресурсам, которыми вы владеете, Amazon EventBridge нуждается в соответствующих разрешениях:

• Для ресурсов Lambda и Amazon SNS EventBridge полагается на политики на основе ресурсов.
• Для экземпляров EC2, потоков данных Kinesis, машин состояний Step Functions и API-интерфейсов API Gateway EventBridge полагается на роли IAM, которые вы указываете в аргументе RoleARN в PutTargets.

Дополнительную информацию см. в разделе Управление аутентификацией и доступом в * Руководстве пользователя Amazon EventBridge *.

Если другой аккаунт Amazon Web Services находится в том же регионе и предоставил вам разрешения (используя PutPermission), вы можете отправлять события в этот аккаунт. Установите событие этого аккаунта в качестве целевого ресурса правил в вашем аккаунте. Чтобы отправлять сопоставленные события в другой аккаунт, укажите событие этого аккаунта как значение Arn при выполнении PutTargets. Если ваш аккаунт отправляет события в другой аккаунт, ваш аккаунт оплачивает каждый отправленный событие. Каждый событие, отправленный в другой аккаунт, оплачивается как пользовательское событие. Аккаунт, получающий событие, не оплачивает его. Дополнительную информацию см. в разделе Цены на Amazon EventBridge.

Если вы устанавливаете событие другого аккаунта в качестве целевого ресурса, и этот аккаунт предоставил разрешение вашему аккаунту через организацию вместо прямого указания ID аккаунта, то необходимо указать RoleArn с соответствующими разрешениями в структуре Target. Дополнительную информацию см. в разделе Отправка и получение событий между аккаунтами Amazon Web Services в Руководстве пользователя Amazon EventBridge.

Дополнительную информацию об активации межаккаунтовых событий см. в разделе PutPermission.

• Если для целевого ресурса не указан ни один из следующих аргументов, то всё событие передается целевому ресурсу в формате JSON (если целевой ресурс не Amazon EC2 Run Command или Amazon ECS task, в этом случае ничего из события не передается целевому ресурсу).
• Если Input указан в виде корректного JSON, то сопоставленное событие заменяется этим постоянным значением.
• Если InputPath указан в формате JSONPath (например, $.detail), то целевому ресурсу передается только часть события, указанная в пути (например, только детальная часть события).
• Если InputTransformer указан, то один или несколько указанных JSONPath извлекаются из события и используются в качестве значений в шаблоне, который вы указываете в качестве ввода для целевого ресурса.

При указании InputPath или InputTransformer, необходимо использовать нотацию JSON с точками, а не с квадратными скобками.

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

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

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

Синопсис

  put-targets
--rule <value>
[--event-bus-name <value>]
--targets <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]

Параметры

--rule (строка)

--event-bus-name (строка)

--targets (список)

Синтаксис JSON:

[
  {
    "Id": "string",
    "Arn": "string",
    "RoleArn": "string",
    "Input": "string",
    "InputPath": "string",
    "InputTransformer": {
      "InputPathsMap": {"string": "string"
        ...},
      "InputTemplate": "string"
    },
    "KinesisParameters": {
      "PartitionKeyPath": "string"
    },
    "RunCommandParameters": {
      "RunCommandTargets": [
        {
          "Key": "string",
          "Values": ["string", ...]
        }
        ...
      ]
    },
    "EcsParameters": {
      "TaskDefinitionArn": "string",
      "TaskCount": integer,
      "LaunchType": "EC2"|"FARGATE"|"EXTERNAL",
      "NetworkConfiguration": {
        "awsvpcConfiguration": {
          "Subnets": ["string", ...],
          "SecurityGroups": ["string", ...],
          "AssignPublicIp": "ENABLED"|"DISABLED"
        }
      },
      "PlatformVersion": "string",
      "Group": "string",
      "CapacityProviderStrategy": [
        {
          "capacityProvider": "string",
          "weight": integer,
          "base": integer
        }
        ...
      ],
      "EnableECSManagedTags": true|false,
      "EnableExecuteCommand": true|false,
      "PlacementConstraints": [
        {
          "type": "distinctInstance"|"memberOf",
          "expression": "string"
        }
        ...
      ],
      "PlacementStrategy": [
        {
          "type": "random"|"spread"|"binpack",
          "field": "string"
        }
        ...
      ],
      "PropagateTags": "TASK_DEFINITION",
      "ReferenceId": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
        ...
      ]
    },
    "BatchParameters": {
      "JobDefinition": "string",
      "JobName": "string",
      "ArrayProperties": {
        "Size": integer
      },
      "RetryStrategy": {
        "Attempts": integer
      }
    },
    "SqsParameters": {
      "MessageGroupId": "string"
    },
    "HttpParameters": {
      "PathParameterValues": ["string", ...],
      "HeaderParameters": {"string": "string"
        ...},
      "QueryStringParameters": {"string": "string"
        ...}
    },
    "RedshiftDataParameters": {
      "SecretManagerArn": "string",
      "Database": "string",
      "DbUser": "string",
      "Sql": "string",
      "StatementName": "string",
      "WithEvent": true|false,
      "Sqls": ["string", ...]
    },
    "SageMakerPipelineParameters": {
      "PipelineParameterList": [
        {
          "Name": "string",
          "Value": "string"
        }
        ...
      ]
    },
    "DeadLetterConfig": {
      "Arn": "string"
    },
    "RetryPolicy": {
      "MaximumRetryAttempts": integer,
      "MaximumEventAgeInSeconds": integer
    },
    "AppSyncParameters": {
      "GraphQLOperation": "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
• 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.

Примеры

Для добавления целевых объектов для правил CloudWatch Events

В этом примере функция Lambda добавляется в качестве целевого объекта правила:

aws events put-targets --rule DailyLambdaFunction --targets "Id"="1","Arn"="arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName"

В этом примере устанавливается поток Amazon Kinesis в качестве целевого объекта, поэтому события, обнаруженные этим правилом, передаются в поток:

aws events put-targets --rule EC2InstanceStateChanges --targets "Id"="1","Arn"="arn:aws:kinesis:us-east-1:123456789012:stream/MyStream","RoleArn"="arn:aws:iam::123456789012:role/MyRoleForThisRule"

В этом примере два потока Amazon Kinesis устанавливаются в качестве целевых объектов для одного правила:

aws events put-targets --rule DailyLambdaFunction --targets "Id"="Target1","Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream1","RoleArn"="arn:aws:iam::379642911888:role/ MyRoleToAccessLambda"  "Id"="Target2"," Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream2","RoleArn"="arn:aws:iam::379642911888:role/MyRoleToAccessLambda"

Вывод

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

FailedEntries -> (список)