update-event-source¶

Description¶

Updates an EventSource. Fields omitted from the request are left unchanged.

Synopsis¶

  update-event-source
--event-source-arn <value>
[--configuration <value>]
[--description <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]
[--cli-error-format <value>]

Options¶

--event-source-arn (string) [required]

EventSource ARN: event-sourcev2///. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the resource’s name. The id segment is a 25-character identifier generated by the service.

Constraints:

min: 1

max: 1011

pattern: arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12}):event-sourcev2\/(aws\.service|aws\.partner)\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

--configuration (tagged union structure)

Discriminated EventSource configuration. Exactly one variant must be set.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: AwsServiceEventsConfiguration, PartnerEventsConfiguration.

AwsServiceEventsConfiguration -> (structure)

Configuration for forwarding a single AWS service’s events from the account’s default event bus.

AwsService -> (string) [required]

A single AWS service source identifier, e.g. “aws.s3”. Wildcards and lists are rejected.

Constraints:

min: 1

max: 256

pattern: aws\.[a-z0-9\-]+

Pattern -> (string)

A filter pattern, as a JSON string, that defines which of the service’s events are forwarded to the event bus. Do not include source, account, or region as top-level fields. If no pattern is specified, all events from the service are forwarded.

Constraints:

min: 0

max: 3753

OnFailureConfiguration -> (structure)

The destination for events that could not be forwarded.

Arn -> (string)

The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.

Constraints:

min: 1

max: 1600

pattern: arn:aws(-[a-z0-9]+)*:sqs:[a-z][a-z0-9]*(-[a-z0-9]+)*:[0-9]{12}:([A-Za-z0-9_-]{1,80}|[A-Za-z0-9_-]{1,75}\.fifo)(?![\s\S]).*

PartnerEventsConfiguration -> (structure)

Configuration for forwarding a partner event source’s events through a managed partner event bus.

PartnerEventSourceArn -> (string) [required]

ARN of the partner event source to forward. It is a partner-owned resource, so the account segment is empty: arn:aws:events:::event-source/aws.partner/.

Constraints:

min: 1

max: 1600

pattern: arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12})?:event-source\/aws\.partner(\/[\.\-_A-Za-z0-9]+){2,}

Pattern -> (string)

A filter pattern, as a JSON string, that defines which of the partner event source’s events are forwarded to the event bus. If no pattern is specified, all events from the partner event source are forwarded.

Constraints:

min: 0

max: 3753

PartnerBusKmsKeyIdentifier -> (string)

Identifier of the AWS KMS customer managed key used to encrypt events: a key ID, key ARN, alias name, or alias ARN. When absent, events are encrypted with an AWS owned key.

Constraints:

min: 0

max: 2048

pattern: [a-zA-Z0-9_\-/:]*

OnFailureConfiguration -> (structure)

The destination for events that could not be forwarded, covering both the forwarding target and the managed partner event bus.

Arn -> (string)

The ARN of the destination that receives events that could not be delivered. An Amazon SQS queue is the supported destination.

Constraints:

min: 1

max: 1600

pattern: arn:aws(-[a-z0-9]+)*:sqs:[a-z][a-z0-9]*(-[a-z0-9]+)*:[0-9]{12}:([A-Za-z0-9_-]{1,80}|[A-Za-z0-9_-]{1,75}\.fifo)(?![\s\S]).*

Shorthand Syntax:

AwsServiceEventsConfiguration={AwsService=string,Pattern=string,OnFailureConfiguration={Arn=string}},PartnerEventsConfiguration={PartnerEventSourceArn=string,Pattern=string,PartnerBusKmsKeyIdentifier=string,OnFailureConfiguration={Arn=string}}

JSON Syntax:

{
  "AwsServiceEventsConfiguration": {
    "AwsService": "string",
    "Pattern": "string",
    "OnFailureConfiguration": {
      "Arn": "string"
    }
  },
  "PartnerEventsConfiguration": {
    "PartnerEventSourceArn": "string",
    "Pattern": "string",
    "PartnerBusKmsKeyIdentifier": "string",
    "OnFailureConfiguration": {
      "Arn": "string"
    }
  }
}

--description (string)

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

Constraints:

min: 0

max: 512

pattern: [^\u0000-\u001F\u007F-\u009F\u2028\u2029]*(?![\s\S]).*

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

EventSourceArn -> (string)

EventSource ARN: event-sourcev2///. The type segment is set by the service (aws.service for AWS service events, aws.partner for partner events) and is not part of the resource’s name. The id segment is a 25-character identifier generated by the service.

Constraints:

min: 1

max: 1011

pattern: arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12}):event-sourcev2\/(aws\.service|aws\.partner)\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

Name -> (string)

EventSource name. First character alphanumeric; the rest may add ‘.’, ‘-’, ‘_’. Names may not begin with the reserved “aws.” prefix. The grammar matches the ARN local-name segment in EventSourceArn (event-sourcev2///), mirroring EventBusName, so a name the ARN cannot represent cannot be created.

Constraints:

min: 1

max: 256

pattern: (?!aws\.)[A-Za-z0-9][\.\-_A-Za-z0-9]*

EventBusArn -> (string)

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Constraints:

min: 1

max: 1011

pattern: arn:aws(-[a-z0-9]+)*:events:[a-z][a-z0-9]*(-[a-z0-9]+)*:([0-9]{12}):event-busv2\/[A-Za-z0-9][\.\-_A-Za-z0-9]{0,255}\/[a-z0-9]{25}

State -> (string)

Lifecycle state of an EventSource. Revocation is reported by the Revoked flag.

Possible values:

CREATING

ACTIVE

UPDATING

CREATE_FAILED

UPDATE_FAILED

DELETING

DELETE_FAILED

LastModifiedTime -> (timestamp)

The time the EventSource was last modified.

Table of Contents

Feedback

User Guide