AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . medialive ]

update-event-bridge-rule-template

Description

Updates the specified eventbridge rule template.

See also: AWS API Documentation

Synopsis

  update-event-bridge-rule-template
[--description <value>]
[--event-targets <value>]
[--event-type <value>]
[--group-identifier <value>]
--identifier <value>
[--name <value>]
[--cli-input-json <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>]

Options

--description (string) A resource's optional description.

--event-targets (list) Placeholder documentation for __listOfEventBridgeRuleTemplateTarget(structure)

The target to which to send matching events.

Arn -> (string)

Target ARNs must be either an SNS topic or CloudWatch log group.

Shorthand Syntax:

Arn=string ...

JSON Syntax:

[
  {
    "Arn": "string"
  }
  ...
]

--event-type (string) The type of event to match with the rule.

Possible values:

  • MEDIALIVE_MULTIPLEX_ALERT
  • MEDIALIVE_MULTIPLEX_STATE_CHANGE
  • MEDIALIVE_CHANNEL_ALERT
  • MEDIALIVE_CHANNEL_INPUT_CHANGE
  • MEDIALIVE_CHANNEL_STATE_CHANGE
  • MEDIAPACKAGE_INPUT_NOTIFICATION
  • MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION
  • MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION
  • SIGNAL_MAP_ACTIVE_ALARM
  • MEDIACONNECT_ALERT
  • MEDIACONNECT_SOURCE_HEALTH
  • MEDIACONNECT_OUTPUT_HEALTH
  • MEDIACONNECT_FLOW_STATUS_CHANGE

--group-identifier (string) An eventbridge rule template group's identifier. Can be either be its id or current name.

--identifier (string) An eventbridge rule template's identifier. Can be either be its id or current name.

--name (string) A resource's name. Names must be unique within the scope of a resource type in a specific region.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Arn -> (string)

An eventbridge rule template's ARN (Amazon Resource Name)

CreatedAt -> (timestamp)

Placeholder documentation for __timestampIso8601

Description -> (string)

A resource's optional description.

EventTargets -> (list)

Placeholder documentation for __listOfEventBridgeRuleTemplateTarget

(structure)

The target to which to send matching events.

Arn -> (string)

Target ARNs must be either an SNS topic or CloudWatch log group.

EventType -> (string)

The type of event to match with the rule.

GroupId -> (string)

An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-

Id -> (string)

An eventbridge rule template's id. AWS provided templates have ids that start with aws-

ModifiedAt -> (timestamp)

Placeholder documentation for __timestampIso8601

Name -> (string)

A resource's name. Names must be unique within the scope of a resource type in a specific region.

Tags -> (map)

Represents the tags associated with a resource.

key -> (string)

Placeholder documentation for __string

value -> (string)

Placeholder documentation for __string