id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
b0639be142d8-1 | 1. Select **Download**\.
It may take a few seconds for your download to begin\. The download file will be a zip file of code bindings for the language you selected\.
Use these code bindings in your own code to help quickly build applications using this EventBridge event\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-tutorial-schema-download-binding.md |
609b24f8521a-0 | Use the following steps to create an EventBridge rule that triggers on an event emitted by an AWS service\.
When an AWS service in your account emits an event, it always goes to your account’s default event bus\. To write a rule that triggers on events from AWS services in your account, you must associate it with the default event bus\. You can create a rule on a custom event bus that looks for events from AWS services, but this rule will trigger only when you receive such an event from another account via cross\-account event delivery\. For more information, see [Sending and Receiving Events Between AWS Accounts](eventbridge-cross-account-event-delivery.md)\.
**To create a rule that triggers on an event**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Rules**\.
1. Choose **Create rule**\.
1. Enter a name and description for the rule\.
A rule can't have the same name as another rule in the same Region and on the same event bus\.
1. For **Define pattern**, choose **Event pattern**\.
1. Choose **Pre\-defined pattern by service**\.
1. For **Service provider**, choose **AWS**\.
1. For **Service name**, choose the name of the service that emits the event\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/create-eventbridge-rule.md |
609b24f8521a-1 | 1. For **Service name**, choose the name of the service that emits the event\.
1. For **Event type**, choose **All Events** or choose the type of event to use for this rule\. If you choose **All Events**, all events emitted by this AWS service will match the rule\.
If you want to customize the event pattern, choose **Edit**, make your changes, and choose **Save**\.
1. For **Select event bus**, choose the event bus that you want to associate with this rule\. If you want this rule to trigger on matching events that come from your own AWS account, select ** AWS default event bus**\. When an AWS service in your account emits an event, it always goes to your account’s default event bus\.
1. For **Select targets**, choose the AWS service that is to act when an event of the selected type is detected\.
1. In the other fields in this section, enter information specific to this target type, if any is needed\.
1. For many target types, EventBridge needs permissions to send events to the target\. In these cases, EventBridge can create the IAM role needed for your rule to run:
+ To create an IAM role automatically, choose **Create a new role for this specific resource**
+ To use an IAM role that you created before, choose **Use existing role**
1. Optionally, choose **Add target** to add another target for this rule\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/create-eventbridge-rule.md |
609b24f8521a-2 | 1. Optionally, choose **Add target** to add another target for this rule\.
1. \(Optional\) Enter one or more tags for the rule\. For more information, see [Tagging Your Amazon EventBridge Resources](eventbridge-tagging.md)\.
1. Choose **Create**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/create-eventbridge-rule.md |
a46338fa7038-0 | EventBridge has the following quotas\.
| Resource | Default Limit |
| --- | --- |
| Event Publishing API requests | [PutEvents](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutEvents.html) operations are limited based on AWS region\. See [PutEvents Quotas by Region](#putevents-limits)\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) |
| All other API requests | All EventBridge API other than `PutEvents` are limited to 50 requests per second by default\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) |
| Event buses | Up to 100 event buses per account\. | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
a46338fa7038-1 | | Event buses | Up to 100 event buses per account\. |
| Event buses \- other quotas | There is no restriction on the rate of events that can be received from AWS services or other AWS accounts\. If you send custom events to your event bus using the `PutEvents` API, the `PutEvents` [API quotas](#putevents-limits) apply\. Any events that are sent on to the targets of the rules in your account count against your invocations quota\. The policy size of an event bus is limited to 10240 characters\. This policy size increases each time you grant access to another account\. You can see your current policy and its size by using the `DescribeEventBus` API\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)\. |
| Event pattern | 2048 characters maximum\. | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
a46338fa7038-2 | | Event pattern | 2048 characters maximum\. |
| Invocations | An invocation is an event matching a rule and being sent on to the rule’s targets\. Quotas vary by region\. See [Invocation Quotas by Region](#invocations-limits)\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)\. |
| [ListRuleNamesByTarget](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_ListRuleNamesByTarget.html) | Up to 100 results per page for requests\. |
| [ListRules](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_ListRules.html) | Up to 100 results per page for requests\. |
| [ListTargetsByRule](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_ListTargetsByRule.html) | Up to 100 results per page for requests\. | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
a46338fa7038-3 | | [PutTargets](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutTargets.html) | 10 entries per request\. Up to 5 targets per rule\. |
| [RemoveTargets](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_RemoveTargets.html) | 10 entries per request\. |
| Rules | 300 per event bus\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)\. Before requesting a quota increase, examine your rules\. You may have multiple rules each matching to very specific events\. Consider broadening their scope by using fewer identifiers in your [Events and Event Patterns in EventBridge](eventbridge-and-event-patterns.md)\. In addition, a rule can invoke several targets each time it matches an event\. Consider adding more targets to your rules\. |
| Systems Manager Run Command target | 1 target key and 1 target value Systems Manager Run Command does not currently support multiple target values\. |
| Targets | Up to 5 targets per rule\. | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
0be5b7e502e9-0 | | Regions | Transactions per Second |
| --- | --- |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | [PutEvents](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutEvents.html) is limited to 2400 requests per second by default in these regions\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
0be5b7e502e9-1 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | [PutEvents](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutEvents.html) is limited to 1200 requests per second by default in these regions\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
0be5b7e502e9-2 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | [PutEvents](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutEvents.html) is limited to 600 requests per second by default in these regions\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
0be5b7e502e9-3 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | [PutEvents](https://docs.aws.amazon.com/AmazonCloudWatchEvents/latest/APIReference/API_PutEvents.html) is limited to 400 requests per second by default in these regions\. You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
2703ac5a7d2f-0 | An invocation is an event matching a rule and being sent on to the rule’s targets\. If the invocation of a target fails due to a problem with the target service, account throttling, etc\., new attempts are made for up to 24 hours for a specific invocation\.
If you are receiving events from another account, each of those events that matches a rule in your account and is sent on to the rule’s targets counts against your account’s quota of invocations per second\.
After your reach the one of the following invocation quotas in your region invocations are throttled\. They still happen but they are delayed\.
| Regions | Invocations per Second |
| --- | --- |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | The invocation quota for these regions is is limited to 4500 requests per second by default in these regions\.You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
2703ac5a7d2f-1 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | The invocation quota for these regions is is limited to 2250 requests per second by default in these regions\.You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | The invocation quota for these regions is is limited to 1100 requests per second by default in these regions\.You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
2703ac5a7d2f-2 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/cloudwatch-limits-eventbridge.html) | The invocation quota for these regions is is limited to 750 requests per second by default in these regions\.You can [request a quota increase](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-cloudwatch-events)\. For instructions, see [AWS Service Quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/cloudwatch-limits-eventbridge.md |
7503f4dbf6d6-0 | You can use an AWS Lambda function that logs each AWS API call\. For example, you can create a rule to log any operation in Amazon EC2, or you can limit this rule to log only a specific API call\. In this tutorial, you log every time an Amazon EC2 instance is stopped\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
86e6314ffa68-0 | Before you can match these events, you must use AWS CloudTrail to set up a trail\. If you don't have a trail, complete the following procedure\.
**To create a trail**
1. Open the CloudTrail console at [https://console\.aws\.amazon\.com/cloudtrail/](https://console.aws.amazon.com/cloudtrail/)\.
1. Choose **Trails**, **Create trail**\.
1. For **Trail name**, type a name for the trail\.
1. For **Storage location**, in **Create a new S3 bucket** type the name for the new bucket that CloudTrail should deliver logs to\.
1. Choose **Create**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
d0a63e101ab1-0 | Create a Lambda function to log the API call events\. Specify this function when you create your rule\.
**To create a Lambda function**
1. Open the AWS Lambda console at [https://console\.aws\.amazon\.com/lambda/](https://console.aws.amazon.com/lambda/)\.
1. If you're new to Lambda, you see a welcome page\. Choose **Get Started Now**\. Otherwise, choose **Create a Lambda function**\.
1. On the **Select blueprint** page, enter `hello` for the filter and choose the **hello\-world** blueprint\.
1. On the **Configure triggers** page, choose **Next**\.
1. On the **Configure function** page, do the following:
1. Enter a name and description for the Lambda function\. For example, name the function `LogEC2StopInstance`\.
1. Edit the sample code for the Lambda function\. For example:
```
'use strict';
exports.handler = (event, context, callback) => {
console.log('LogEC2StopInstance');
console.log('Received event:', JSON.stringify(event, null, 2));
callback(null, 'Finished');
};
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
d0a63e101ab1-1 | callback(null, 'Finished');
};
```
1. For **Role**, choose **Choose an existing role**\. For **Existing role**, select your basic execution role\. Otherwise, create a basic execution role\.
1. Choose **Next**\.
1. On the **Review** page, choose **Create function**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
4c8b49535d15-0 | Create a rule to run your Lambda function whenever you stop an Amazon EC2 instance\.
**To create a rule**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Rules**\.
1. Choose **Create rule**\.
1. Enter a name and description for the rule\.
1. For **Define pattern**, do the following:
1. Choose **Event pattern**\.
1. Choose **Pre\-defined pattern by service**\.
1. For **Service provider**, choose **AWS**\.
1. For **Service Name**, choose **EC2**\.
1. For **Event type**, choose **AWS API Call via CloudTrail**\.
1. Choose **Specific operations\(s\)** and enter `StopInstances` in the box\.
1. By default, the rule matches any Amazon EC2 Auto Scaling group in the Region\. To make the rule match a specific group, choose **Specific group name\(s\)** and select one or more groups\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
4c8b49535d15-1 | 1. For **Select event bus**, choose **AWS default event bus**\. When an AWS service in your account emits an event, it always goes to your account’s default event bus\.
1. For **Targets**, choose **Add target**, **Lambda function**\.
1. For **Function**, select the Lambda function that you created\.
1. Choose **Create**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
4010dc91e33e-0 | You can test your rule by stopping an Amazon EC2 instance using the Amazon EC2 console\. After waiting a few minutes for the instance to stop, check your AWS Lambda metrics on the CloudWatch console to verify that your function was invoked\.
**To test your rule by stopping an instance**
1. Open the Amazon EC2 console at [https://console\.aws\.amazon\.com/ec2/](https://console.aws.amazon.com/ec2/)\.
1. Launch an instance\. For more information, see [Launch Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/LaunchingAndUsingInstances.html) in the *Amazon EC2 User Guide for Linux Instances*\.
1. Stop the instance\. For more information, see [Stop and Start Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) in the *Amazon EC2 User Guide for Linux Instances*\.
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Rules**, choose the name of the rule that you created, and choose **Metrics for the rule**\.
1. To view the output from your Lambda function, do the following: | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
4010dc91e33e-1 | 1. To view the output from your Lambda function, do the following:
1. Open the CloudWatch console at [https://console\.aws\.amazon\.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/)\.
1. In the navigation pane, choose **Logs**\.
1. Select the name of the log group for your Lambda function \(`/aws/lambda/function-name`\)\.
1. Select the name of the log stream to view the data provided by the function for the instance that you stopped\.
1. \(Optional\) When you're finished, terminate the stopped instance\. For more information, see [Terminate Your Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html) in the *Amazon EC2 User Guide for Linux Instances*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/log-api-call.md |
4fbc61ef5322-0 | You can create a pattern that matches an event field that has a null value or an empty string\. To see how this works, consider the following example event:
```
{
"version": "0",
"id": "3e3c153a-8339-4e30-8c35-687ebef853fe",
"detail-type": "EC2 Instance Launch Successful",
"source": "aws.autoscaling",
"account": "123456789012",
"time": "2015-11-11T21:31:47Z",
"region": "us-east-1",
"resources": [
],
"detail": {
"eventVersion": "",
"responseElements": null
}
}
```
To match events where the value of `eventVersion` is an empty string, use the following pattern, which would match the event example\.
```
{
"detail": {
"eventVersion": [""]
}
}
```
To match events where the value of `responseElements` is null, use the following pattern, which would match the event example\.
```
{
"detail": { | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-event-patterns-null-and-empty-strings.md |
4fbc61ef5322-1 | ```
{
"detail": {
"responseElements": [null]
}
}
```
Null values and empty strings are not interchangeable in pattern matching\. A pattern that is written to detect empty strings will not catch values of `null`\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-event-patterns-null-and-empty-strings.md |
65e32c25966a-0 | The EventBridge Schema Registry allows you to discover, create, and manage OpenAPI schemas for events on EventBridge\. You can find schemas for existing AWS services, create and upload custom schemas, or generate a schema based on events on an event bus\. For all schemas in EventBridge you can generate and download code bindings to help quickly build applications that use those events\.
Schemas are available for the events of all AWS services on Amazon EventBridge\. You can also create or upload schemas, or automatically infer schemas directly from events on an event bus\. Once you have found or created a schema for an event, you can download code bindings for popular programming languages\. You can browse, search, create, upload, and generate code bindings for schemas\. You can manage schemas from the Amazon EventBridge console, using the API, or directly in your IDE using the AWS Toolkits\. You can quickly build serverless apps that use events using the AWS Serverless Application Model\.
For information about using the EventBridge Schema Registry with the API, or through Amazon CloudFront, see the following\.
+ [Amazon EventBridge Schema Registry API Reference](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/index.html)
+ [EventSchemas Resource Type Reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_EventSchemas.html) in AWS CloudFormation
**Topics** | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
65e32c25966a-1 | **Topics**
+ [Discover Existing AWS Event Schemas](#eventbridge-schemas-aws)
+ [Schema Registries](#eventbridge-schemas-registries)
+ [Upload or Create Schemas](#eventbridge-schemas-create)
+ [Generate a Schema from Event JSON](#eventbridge-schemas-infer-from-json)
+ [Generate a Schema Based on Events on an Event Bus](#eventbridge-schemas-infer)
+ [Generate Code Bindings for EventBridge Schemas](#eventbridge-schemas-bindings)
+ [EventBridge Schema Registry Integration with AWS Toolkits](#eventbridge-schemas-toolkits) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
5b683a241ad9-0 | Amazon EventBridge includes schemas for all AWS services on EventBridge\. You can search or browse these schemas in the Amazon EventBridge console, or by using API actions \(see [https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-registries-name-registryname-schemas-search.html](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-registries-name-registryname-schemas-search.html)\)\.
**To find schemas for AWS services**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Schemas**\.
1. On the **Schemas** page, select **AWS event schema registry**\.
The first page of available schemas is displayed\.
1. To search for a schema, enter a search term in the **Search AWS event schemas\.**
A search returns matches for both the name and contents of the available schemas, and will display which versions of the schema it was found in\.
1. Open an event schema by selecting the name of the schema\.
The **Schema details** page is displayed\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
6c29286f5455-0 | Schema registries are containers for Schemas\. Registries collect and organize schemas so that your schemas are in logical groups\. You can view **All schemas,** or the built\-in schemas, **AWS event schema registry** and **Discovered schema registry**\. You can also create custom registries to collect and organize the schemas you create or upload\.
**To create a custom registry**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Schemas** and then **Create registry**\.
1. On the **Registry details** page enter a **Name**\.
1. Optionally, enter a description for your new registry
1. Choose **Create**\.
The custom registry is created\. You can now see it on the main **Schemas** page\.
You can select **Create custom schema** from your new registry, or select that registry when you are creating a new schema\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
6c29286f5455-1 | You can select **Create custom schema** from your new registry, or select that registry when you are creating a new schema\.
To create a registry using the Amazon EventBridge Schema Registry API, use the [https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-registries-name-registryname.html#v1-registries-name-registryname-http-methods](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-registries-name-registryname.html#v1-registries-name-registryname-http-methods) API action\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
4ce08c52ae66-0 | Schemas are defined using JSON files, using the [OpenAPI Specification](https://swagger.io/docs/specification/)\. You can create or upload your own event schemas in EventBridge using this specification\. You can download a template, or you can edit a template directly in the EventBridge console\.
**To create a schema from a downloaded template**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Schema registry**\.
1. In the **Getting started** section under **Schema template**, choose **Download**\.
1. Alternatively, you can download the JSON from the following code example\.
```
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Event"
},
"paths": {},
"components": {
"schemas": {
"Event": {
"type": "object",
"properties": {
"ordinal": {
"type": "number",
"format": "int64"
}, | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
4ce08c52ae66-1 | "ordinal": {
"type": "number",
"format": "int64"
},
"name": {
"type": "string"
},
"price": {
"type": "number",
"format": "double"
},
"address": {
"type": "string"
},
"comments": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
```
1. Edit the template so that the schema matches your events\. For more information on events, see [Events and Event Patterns in EventBridge](eventbridge-and-event-patterns.md)\.
**To upload a schema file**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
4ce08c52ae66-2 | 1. In the navigation pane, choose **Schemas** and then **Create schema**\.
1. Optionally, select or create a schema registry\.
1. Under **Schema details** enter a name for your schema\.
1. Optionally, enter a description for the schema you created\.
1. With the **Create** tab selected, either drag your schema file to the text box, or paste the schema source\.
1. Select **Create**\.
**To edit a template directly in the console**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Schemas** and then **Create schema**\.
1. Optionally, select or create a schema registry\.
1. Under **Schema details** enter a name for your schema\.
1. Optionally, enter a description for the schema you created\.
1. With the **Create** tab selected, choose **Load template**\.
1. Edit the template so that the schema matches your events\. For more information on events, see [Events and Event Patterns in EventBridge](eventbridge-and-event-patterns.md)\.
1. Select **Create**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
4ce08c52ae66-3 | 1. Select **Create**\.
To create a schema using the EventBridge Schema Registry API, use the [https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-registries-name-registryname-schemas-name-schemaname.html#v1-registries-nam](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-registries-name-registryname-schemas-name-schemaname.html#v1-registries-nam) API action\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
967bed875174-0 | With the JSON of an event, you can automatically generate a schema for those types of events\. Given existing event code, you can quickly generate a custom schema\. Once the schema has been generated, you can download code bindings to help create applications for those types of events\.
**To generate an EventBridge schema based on event JSON**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Schemas** and then **Create schema**\.
1. Optionally, select or create a schema registry\.
1. Under **Schema details** enter a name for your schema\.
1. Optionally, enter a description for the schema you created\.
1. Select **Discover from JSON**
1. In the text box under **JSON**, paste or drag the JSON source of an event\.
As an example, you could paste in the source from this AWS Step Functions event for a failed execution\.
```
{
"version": "0",
"id": "315c1398-40ff-a850-213b-158f73e60175",
"detail-type": "Step Functions Execution Status Change",
"source": "aws.states", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
967bed875174-1 | "detail-type": "Step Functions Execution Status Change",
"source": "aws.states",
"account": "012345678912",
"time": "2019-02-26T19:42:21Z",
"region": "us-east-1",
"resources": [
"arn:aws:states:us-east-1:012345678912:execution:state-machine-name:execution-name"
],
"detail": {
"executionArn": "arn:aws:states:us-east-1:012345678912:execution:state-machine-name:execution-name",
"stateMachineArn": "arn:aws:states:us-east-1:012345678912:stateMachine:state-machine",
"name": "execution-name",
"status": "FAILED",
"startDate": 1551225146847,
"stopDate": 1551225151881,
"input": "{}",
"output": null
}
}
```
1. Select **Discover schema**\.
1. EventBridge will generate an OpenAPI schema for the event\. For example, the following is the generated schema for the event you pasted in\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
967bed875174-2 | 1. EventBridge will generate an OpenAPI schema for the event\. For example, the following is the generated schema for the event you pasted in\.
```
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "StepFunctionsExecutionStatusChange"
},
"paths": {},
"components": {
"schemas": {
"AWSEvent": {
"type": "object",
"required": ["detail-type", "resources", "detail", "id", "source", "time", "region", "version", "account"],
"x-amazon-events-detail-type": "Step Functions Execution Status Change",
"x-amazon-events-source": "aws.states",
"properties": {
"detail": {
"$ref": "#/components/schemas/StepFunctionsExecutionStatusChange"
},
"account": {
"type": "string"
},
"detail-type": {
"type": "string"
},
"id": {
"type": "string" | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
967bed875174-3 | "type": "string"
},
"id": {
"type": "string"
},
"region": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"type": "string"
},
"time": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "string"
}
}
},
"StepFunctionsExecutionStatusChange": {
"type": "object",
"required": ["output", "input", "executionArn", "name", "stateMachineArn", "startDate", "stopDate", "status"],
"properties": {
"executionArn": {
"type": "string"
},
"input": {
"type": "string"
},
"name": {
"type": "string"
}, | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
967bed875174-4 | },
"name": {
"type": "string"
},
"output": {},
"startDate": {
"type": "integer",
"format": "int64"
},
"stateMachineArn": {
"type": "string"
},
"status": {
"type": "string"
},
"stopDate": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
```
1. Once the schema has been generated, select **Create**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
63978b1dedc7-0 | Amazon EventBridge can infer schemas based on events on an event bus\. Enabling event discovery on an event bus will generate schemas for events on that bus\.
**Note**
Enabling event discovery on an event bus may incur a cost\. The first five million ingested events in each month is free\.
**To enable schema discovery on an event bus**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Event buses**\.
1. To enable discovery on the **Default event bus**, select **Start discovery**\.
1. To enable discovery on a **Custom event bus**, select the radio button for the custom event bus and choose **Start Discovery**\.
Discovered schemas will show up in the **Discovered schemas registry** on the **Schemas** page\. Changes to the contents of events on that bus will create new versions of the related EventBridge schema in the **Discovered schemas registry**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
5e14cfa0b9bd-0 | You can generate code bindings for event schemas to speed development for Java, Python, and TypeScript\. You can get code bindings for existing AWS services, schemas you create, and for schemas you generate based on events on an event bus\. You can generate code bindings for a schema using the EventBridge console, the EventBridge Schema Registry API, and directly in your IDE with the AWS Toolkit\.
You must enable discovery on an event bus to generate code bindings\.
**To generate code bindings from an EventBridge schema**
1. Open the Amazon EventBridge console at [https://console\.aws\.amazon\.com/events/](https://console.aws.amazon.com/events/)\.
1. In the navigation pane, choose **Schemas**\.
1. Find a schema that you would like code bindings for, either by looking through the schema registries, or by searching for a schema\.
1. Select the schema name to display the **Schema details** page\.
1. In the **Version** section, select **Download code bindings**\.
1. On the **Download code bindings** page, select the language of the code bindings you want to download\.
1. Select **Download**\.
It may take a few seconds for your download to begin\. The download file will be a zip file of code bindings for the language you selected\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
2e8e624d7c2b-0 | EventBridge Schema Registry integrates with some AWS Toolkits, letting you browse or search for schemas and download code bindings for schemas directly in your IDE\.
For more information, see the following AWS Toolkit documentation links\.
+ [AWS Toolkit for JetBrains](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/eventbridge-schemas.html)
+ [AWS Toolkit for VS Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/working-with-aws.html) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-schemas.md |
6424b6c6eded-0 | Other AWS services can create and manage EventBridge rules in your AWS account that are needed for certain functions in those services\. These are called *managed rules*\.
When a service creates a managed rule, it may also create an IAM policy that grants permissions to that service to create the rule\. IAM policies created this way are scoped narrowly with resource\-level permissions, to allow the creation of only the necessary rules\.
You can delete managed rules by using the **Force delete** option\. Do so only if you are sure that the other service no longer needs the rule\. Otherwise, deleting a managed rule causes the features that rely on it to stop working\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-managed-rules.md |
99cc6086481b-0 | Amazon EventBridge is a serverless event bus service that makes it easy to connect your applications with data from a variety of sources\. EventBridge delivers a stream of real\-time data from your own applications, Software\-as\-a\-Service \(SaaS\) applications, and AWS services and routes that data to targets such as AWS Lambda\. You can set up routing rules to determine where to send your data to build application architectures that react in real time to all of your data sources\. EventBridge allows you to build event driven architectures, which are loosely coupled and distributed\.
EventBridge was formerly called Amazon CloudWatch Events\. It includes new features that enable you to receive events from SaaS partners and your own applications\. Existing CloudWatch Events users can access their existing default bus, rules, and events in the new EventBridge console and in the CloudWatch Events console\. EventBridge uses the same CloudWatch Events API, so all of your existing CloudWatch Events API usage remains the same\.
You can configure the following AWS resources as targets for EventBridge:
+ Lambda functions
+ Amazon EC2 instances
+ Streams in Amazon Kinesis Data Streams
+ Delivery streams in Amazon Kinesis Data Firehose
+ Log groups in Amazon CloudWatch Logs
+ Amazon ECS tasks
+ Systems Manager Run Command
+ Systems Manager Automation
+ AWS Batch jobs
+ AWS Step Functions state machines
+ Pipelines in AWS CodePipeline
+ AWS CodeBuild projects
+ Amazon Inspector assessment templates
+ Amazon SNS topics
+ Amazon SQS queues | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/what-is-amazon-eventbridge.md |
99cc6086481b-1 | + AWS CodeBuild projects
+ Amazon Inspector assessment templates
+ Amazon SNS topics
+ Amazon SQS queues
+ Built\-in targets: `EC2 CreateSnapshot API call`, `EC2 RebootInstances API call`, `EC2 StopInstances API call`, and `EC2 TerminateInstances API call`
+ The default event bus of another AWS account | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/what-is-amazon-eventbridge.md |
f39a2d628c91-0 | Before you begin using EventBridge, you should understand the following concepts:
+ **Events** – An event indicates a change in an environment\. This can be an AWS environment, an SaaS partner service or application, or one of your own custom applications or services\. For example, Amazon EC2 generates an event when the state of an EC2 instance changes from pending to running, and Amazon EC2 Auto Scaling generates events when it launches or terminates instances\. AWS CloudTrail publishes events when you make API calls\. You can also set up scheduled events that are generated on a periodic basis\. For a list of services that generate events, and sample events from each service, see [EventBridge Event Examples from Supported AWS Services](event-types.md)\.
+ **Rules** – A rule matches incoming events and routes them to targets for processing\. A single rule can route to multiple targets, all of which are processed in parallel\. Rules aren't processed in a particular order\. This enables different parts of an organization to look for and process the events that are of interest to them\. A rule can customize the JSON sent to the target, by passing only certain parts or by overwriting it with a constant\.
+ **Targets** – A target processes events\. Targets can include Amazon EC2 instances, Lambda functions, Kinesis streams, Amazon ECS tasks, Step Functions state machines, Amazon SNS topics, Amazon SQS queues, and built\-in targets\. A target receives events in JSON format\.
A rule's targets must be in the same Region as the rule\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/what-is-amazon-eventbridge.md |
f39a2d628c91-1 | A rule's targets must be in the same Region as the rule\.
+ **Event buses** – An event bus receives events\. When you create a rule, you associate it with a specific event bus, and the rule is matched only to events received by that event bus\.
Your account has one default event bus, which receives events from AWS services\. You can create custom event buses to receive events from your custom applications\. You can also create partner event buses to receive events from SaaS partner applications\.
+ **Partner event sources** – A partner event source is used by an AWS partner to send events to an AWS customer account\. To receive these events, the customer must associate an event bus with the partner event source\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/what-is-amazon-eventbridge.md |
a474a68b33f9-0 | You can use the following services with EventBridge:
+ **AWS CloudTrail** enables you to monitor the calls made to the EventBridge API for your account, including calls made by the AWS Management Console, the AWS CLI and other services\. When CloudTrail logging is turned on, EventBridge writes log files to an S3 bucket\. Each log file contains one or more records, depending on how many actions are performed to satisfy a request\. For more information, see [Logging and Monitoring in Amazon EventBridge](logging-cw-api-calls-eventbridge.md)\.
+ **AWS CloudFormation** enables you to model and set up your AWS resources\. You create a template that describes the AWS resources you want, and AWS CloudFormation takes care of provisioning and configuring those resources for you\. You can use EventBridge rules in your AWS CloudFormation templates\. For more information, see [AWS::Events::Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-rule.html) in the *AWS CloudFormation User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/what-is-amazon-eventbridge.md |
a474a68b33f9-1 | + **AWS Config** enables you to record configuration changes to your AWS resources\. This includes how resources relate to one another and how they were configured in the past, so that you can see how the configurations and relationships change over time\. You can also create AWS Config rules to check whether your resources are compliant or noncompliant with your organization's policies\. For more information, see the [AWS Config Developer Guide](https://docs.aws.amazon.com/config/latest/developerguide/)\.
+ **AWS Identity and Access Management \(IAM\)** helps you securely control access to AWS resources for your users\. Use IAM to control who can use your AWS resources \(authentication\), what resources they can use, and how they can use them \(authorization\)\. For more information, see [Identity and Access Management in Amazon EventBridge](auth-and-access-control-eventbridge.md)\.
+ **Amazon Kinesis Data Streams** enables rapid and nearly continuous data intake and aggregation\. The type of data used includes IT infrastructure log data, application logs, social media, market data feeds, and web clickstream data\. Because the response time for the data intake and processing is in real time, processing is typically lightweight\. For more information, see the [Amazon Kinesis Data Streams Developer Guide](https://docs.aws.amazon.com/streams/latest/dev/)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/what-is-amazon-eventbridge.md |
a474a68b33f9-2 | + **AWS Lambda** enables you to build applications that respond quickly to new information\. Upload your application code as Lambda functions, and Lambda runs your code on high\-availability compute infrastructure\. Lambda performs all the administration of the compute resources, including server and operating system maintenance, capacity provisioning, automatic scaling, code and security patch deployment, and code monitoring and logging\. For more information, see the [AWS Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/what-is-amazon-eventbridge.md |
de7b975fd957-0 | EventBridge sends metrics to Amazon CloudWatch every minute\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-monitoring-cloudwatch-metrics.md |
068171b533a0-0 | The `AWS/Events` namespace includes the following metrics\.
All of these metrics use Count as the unit, so Sum and SampleCount are the most useful statistics\.
| Metric | Description |
| --- | --- |
| `DeadLetterInvocations` | Measures the number of times a rule’s target is not invoked in response to an event\. This includes invocations that would result in triggering the same rule again, causing an infinite loop\. Valid Dimensions: RuleName Units: Count |
| `Invocations` | Measures the number of times a target is invoked for a rule in response to an event\. This includes successful and failed invocations, but does not include throttled or retried attempts until they fail permanently\. It does not include DeadLetterInvocations\. EventBridge only sends this metric to CloudWatch if it has a non\-zero value\. Valid Dimensions: RuleName Units: Count |
| `FailedInvocations` | Measures the number of invocations that failed permanently\. This does not include invocations that are retried, or that succeeded after a retry attempt\. It also does not count failed invocations that are counted in DeadLetterInvocations\. Valid Dimensions: RuleName Units: Count |
| `TriggeredRules` | Measures the number of triggered rules that matched with any event\. Valid Dimensions: RuleName Units: Count |
| `MatchedEvents` | Measures the number of events that matched with any rule\. Valid Dimensions: None Units: Count |
| `ThrottledRules` | Measures the number of triggered rules that are being throttled\. Valid Dimensions: RuleName Units: Count | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-monitoring-cloudwatch-metrics.md |
6bd85e707e20-0 | EventBridge metrics have one dimension, which is listed below\.
| Dimension | Description |
| --- | --- |
| RuleName | Filters the available metrics by rule name\. | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/eventbridge-monitoring-cloudwatch-metrics.md |
d1fc3e3294ea-0 | The following table describes important changes in each release of the *Amazon EventBridge User Guide*, beginning in July 2019\. For notification about updates to this documentation, you can subscribe to an RSS feed\.
| Change | Description | Release Date |
| --- | --- | --- |
| Tags for Event Buses | This release allows you to create and manage tags for event buses\. You can add tags when creating an event bus, and add or manage existing tags by calling the related API\. For more information, see the following\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/document-history-eventbridge.html) | February 24, 2020 |
| Increased service quotas | Amazon EventBridge has increased quotas for invocations and for `PutEvents`\. Quotas vary by region, and can be increased if necessary\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/document-history-eventbridge.html) | February 11, 2020 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/document-history-eventbridge.md |
d1fc3e3294ea-1 | | Added a new topic on transforming target input, and added a link to Application Auto Scaling Events\. | Improved documentation on the input transformer\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/document-history-eventbridge.html) Added a link to Application Auto Scaling Events\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/document-history-eventbridge.html) | December 20, 2019 |
| Content\-based filtering | Amazon EventBridge now supports content\-based filtering with event patterns\. For more information see [Content\-based Filtering with Event Patterns](content-filtering-with-event-patterns.md)\. | December 19, 2019 |
| Added links to Amazon Augmented AI event examples\. | Added a link to the Amazon Augmented AI topic in the Amazon SageMaker Developer Guide that provides example events for Amazon Augmented AI\. For more information, see the following\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/document-history-eventbridge.html) | December 13, 2019 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/document-history-eventbridge.md |
d1fc3e3294ea-2 | | Added links to Amazon Chime event examples\. | Added a link to the Amazon Chime topic that provides example events for that service\. For more information, see the following\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/document-history-eventbridge.html) | December 12, 2019 |
| Amazon EventBridge Schemas | You can now manage schemas and generate code bindings for events in Amazon EventBridge\. For more information, see the following\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/eventbridge/latest/userguide/document-history-eventbridge.html) | December 1, 2019 |
| AWS CloudFormation support for Event Buses | AWS CloudFormation now supports the EventBus resource\. It also supports the EventBusName parameter in both the EventBusPolicy and Rule resources\. For more information, see [Amazon EventBridge Resource Type Reference ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_Events.html)\. | October 7, 2019 |
| New service | Initial release of Amazon EventBridge\. | July 11, 2019 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-eventbridge-user-guide/doc_source/document-history-eventbridge.md |
6ad1351f9b1f-0 | For the latest AWS terminology, see the [AWS glossary](https://docs.aws.amazon.com/general/latest/gr/glos-chap.html) in the *AWS General Reference*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/glossary.md |
5d56e7871ae9-0 | Developers can use the AWS Command Line Interface \(AWS CLI\), Amazon Chime API, or AWS SDK to create proxy phone sessions for use with Amazon Chime Voice Connectors\. Proxy phone sessions allow participants to call or send text messages to each other without revealing private phone numbers\.
Creating proxy phone sessions requires the following:
+ The ability to program\.
+ An AWS account\.
+ An AWS Identity and Access Management \(IAM\) role that grants permission to access the Amazon Chime API actions used to create proxy phone sessions, such as the following:
+ `chime:CreateProxySession`
+ `chime:DeleteProxySession`
+ `chime:DeleteVoiceConnectorProxy`
+ `chime:GetProxySession`
+ `chime:GetVoiceConnectorProxy`
+ `chime:ListProxySessions`
+ `chime:PutVoiceConnectorProxy`
+ `chime:UpdateProxySession`
For more information, see [Amazon Chime identity\-based policies](https://docs.aws.amazon.com/chime/latest/ag/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies) in the *Amazon Chime Administrator Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/proxy-phone-sessions.md |
5d56e7871ae9-1 | + An Amazon Chime Voice Connector created by an Amazon Chime account administrator\. For more information, see [Managing Amazon Chime Voice Connectors](https://docs.aws.amazon.com/chime/latest/ag/voice-connectors.html) in the *Amazon Chime Administrator Guide*\.
The following procedure demonstrates how to create a proxy phone session\.
**To create a proxy phone session**
1. Use the [PutVoiceConnectorProxy](https://docs.aws.amazon.com/chime/latest/APIReference/API_PutVoiceConnectorProxy.html) action in the *Amazon Chime API Reference* to configure the Amazon Chime Voice Connector for the proxy phone session\.
1. Use the [CreateProxySession](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateProxySession.html) action in the *Amazon Chime API Reference* to create the proxy phone session\.
For more information about the available Amazon Chime API actions for proxy phone sessions, see the [https://docs.aws.amazon.com/chime/latest/APIReference/Welcome.html](https://docs.aws.amazon.com/chime/latest/APIReference/Welcome.html)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/proxy-phone-sessions.md |
69849c8ccab4-0 | The following example shows how to download a list of users associated with your Amazon Chime administrative account in `.csv` format\.
```
BufferedWriter writer = Files.newBufferedWriter(Paths.get("/path/to/csv"));
CSVPrinter printer = new CSVPrinter(writer, CSVFormat.DEFAULT.withHeader("userId", "email"));
ListUsersRequest listUsersRequest = new ListUsersRequest()
.withAccountId(accountId)
.withMaxResults(1);
boolean done = false;
while (!done) {
ListUsersResult listUsersResult = chime.listUsers(listUsersRequest);
for (User user: listUsersResult.getUsers()) {
printer.printRecord(user.getUserId(), user.getPrimaryEmail());
}
if (listUsersResult.getNextToken() == null) {
done = true;
}
listUsersRequest = new ListUsersRequest()
.withAccountId(accountId)
.withNextToken(listUsersResult.getNextToken());
}
printer.close();
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/download-users.md |
1c01c48ca8b2-0 | The following code snippets can help developers manage Amazon Chime users\. All of the examples in this topic use Java\.
**Topics**
+ [Invite multiple users](invite-users.md)
+ [Download user list](download-users.md)
+ [Log out multiple users](logout-users.md)
+ [Update user personal PINs](update-pins.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/users.md |
4d6b29b23234-0 | The following events are sent to your chatbot from Amazon Chime:
+ **Invite** – Sent when your chatbot is added to an Amazon Chime chat room
+ **Mention** – Sent when a user in a chat room @mentions your chatbot
+ **Remove** – Sent when your chatbot is removed from an Amazon Chime chat room
The following examples show the JSON payload sent to your chatbot for each of these events\.
**Example : Invite event**
```
{
"Sender": {
"SenderId": "user@example.com",
"SenderIdType": "EmailId"
},
"Discussion": {
"DiscussionId": "abcdef12-g34h-56i7-j8kl-mn9opqr012st",
"DiscussionType": "Room"
},
"EventType": "Invite",
"InboundHttpsEndpoint": {
"EndpointType": "Persistent", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/events-bots.md |
4d6b29b23234-1 | "EventType": "Invite",
"InboundHttpsEndpoint": {
"EndpointType": "Persistent",
"Url": "https://hooks.a.chime.aws/incomingwebhooks/a1b2c34d-5678-90e1-f23g-h45i67j8901k?token=ABCDefGHiJK1LMnoP2Q3RST4uvwxYZAbC56DeFghIJkLM7N8OP9QRsTuV0WXYZABcdefgHiJ"
},
"EventTimestamp": "2019-04-04T21:27:52.736Z"
}
```
**Example : Mention event**
```
{
"Sender": {
"SenderId": "user@example.com",
"SenderIdType": "EmailId"
},
"Discussion": {
"DiscussionId": "abcdef12-g34h-56i7-j8kl-mn9opqr012st",
"DiscussionType": "Room"
},
"EventType": "Mention",
"InboundHttpsEndpoint": {
"EndpointType": "ShortLived", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/events-bots.md |
4d6b29b23234-2 | "InboundHttpsEndpoint": {
"EndpointType": "ShortLived",
"Url": "https://hooks.a.chime.aws/incomingwebhooks/a1b2c34d-5678-90e1-f23g-h45i67j8901k?token=ABCDefGHiJK1LMnoP2Q3RST4uvwxYZAbC56DeFghIJkLM7N8OP9QRsTuV0WXYZABcdefgHiJ"
},
"EventTimestamp": "2019-04-04T21:30:43.181Z",
"Message": "@botDisplayName@example.com Hello Chatbot"
}
```
**Note**
The `InboundHttpsEndpoint` URL for a Mention event expires 2 minutes after it is sent\.
**Example : Remove event**
```
{
"Sender": {
"SenderId": "user@example.com",
"SenderIdType": "EmailId"
},
"Discussion": {
"DiscussionId": "abcdef12-g34h-56i7-j8kl-mn9opqr012st",
"DiscussionType": "Room"
},
"EventType": "Remove", | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/events-bots.md |
4d6b29b23234-3 | "DiscussionType": "Room"
},
"EventType": "Remove",
"EventTimestamp": "2019-04-04T21:27:29.626Z"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/events-bots.md |
1822678071b0-0 | The following example shows how to reset the personal meeting PIN for a specified Amazon Chime user\.
```
ResetPersonalPINRequest request = new ResetPersonalPINRequest()
.withAccountId("chimeAccountId")
.withUserId("userId");
ResetPersonalPINResult result = chime.resetPersonalPIN(request);
User user = result.getUser();
user.getPersonalPIN()
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/update-pins.md |
d7d6628722be-0 | Before you can build real\-time meeting clients with the Amazon Chime SDK, you must integrate your client application with an Amazon Chime SDK client library\. The following client libraries are available:
+ [Amazon Chime SDK client library for JavaScript](https://github.com/aws/amazon-chime-sdk-js) \([NPM](https://www.npmjs.com/package/amazon-chime-sdk-js)\) – A JavaScript library with TypeScript type definitions that helps you build Amazon Chime SDK applications in WebRTC\-enabled browsers\.
+ [Amazon Chime SDK client library for iOS](https://github.com/aws/amazon-chime-sdk-ios) – A Swift library that helps you build Amazon Chime SDK applications on supported iOS devices\.
+ [Amazon Chime SDK client library for Android](https://github.com/aws/amazon-chime-sdk-android) – A Kotlin library that helps you build Amazon Chime SDK applications on supported Android devices\.
To learn how to integrate your client application with the Amazon Chime SDK, see the instructions in the client library `README.md`\. Use the demos to learn how to build specific media components for your application\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-client-lib.md |
8f8eefb49a9b-0 | The following procedure demonstrates how to create a meeting with audio and video for your server and client applications\. Before you begin, you must integrate your client application with an Amazon Chime SDK client library\. For more information, see [Integrating with a client library](mtgs-sdk-client-lib.md)\.
**To create a meeting with audio and video**
1. Complete the following steps from your server application:
1. Use the [CreateMeeting](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateMeeting.html) API action in the *Amazon Chime API Reference* to create a meeting\. Optionally, specify an AWS Region using the `MediaRegion` parameter\. For more information about choosing a media Region, see [Amazon Chime SDK media Regions](chime-sdk-meetings-regions.md)\.
1. Add attendees to the meeting using either the [CreateAttendee](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html) API action or the [BatchCreateAttendee](https://docs.aws.amazon.com/chime/latest/APIReference/API_BatchCreateAttendee.html) API action\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-mtgs.md |
8f8eefb49a9b-1 | 1. Securely transfer the meeting and attendee from your server application to the client authorized as the respective attendee\. For more information about meetings and attendees, see [Meeting](https://docs.aws.amazon.com/chime/latest/APIReference/API_Meeting.html) and [Attendee](https://docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.html) in the *Amazon Chime API Reference*\.
1. Complete the following steps from your client application:
1. Use an Amazon Chime SDK client library to construct a `MeetingSessionConfiguration` object\. Use the meeting and attendee information from the previous steps\.
1. Implement the `AudioVideoObserver` interface\.
1. Create a `MeetingSession` using the `MeetingSessionConfiguration`\.
1. Use the `AudioVideoFacade` from the `MeetingSession` to control real\-time media\.
1. Register an instance of the `AudioVideoObserver` interface\. This lets you receive events when the meeting state changes\.
1. Select initial devices for the audio input, audio output, and video input\.
1. Start the audiovisual session\.
1. Start local video capture when the user wants to share video\.
1. To show video tiles, manage video tile events, and bind the tiles to video surfaces in the client application\.
1. Manage other user interactions such as muting and unmuting, or starting and stopping local video capture\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-mtgs.md |
8f8eefb49a9b-2 | 1. Manage other user interactions such as muting and unmuting, or starting and stopping local video capture\.
1. To leave the meeting, stop the audiovisual session\.
1. \(Optional\) Use the `AudioVideoFacade` from the `MeetingSession` to share media content, such as screen captures, with other clients\.
1. Start the screen share session\. The content joins the meeting as an additional attendee\.
1. To view the shared content, manage video tile events and bind the tiles to surfaces in the client application\.
1. Manage other interactions, such as pausing, restarting, or stopping the content share\.
The meetings end when you run the [DeleteMeeting](https://docs.aws.amazon.com/chime/latest/APIReference/API_DeleteMeeting.html) API action\. A meeting automatically ends after a period of inactivity, such as the following:
+ No audio connections are present in the meeting for more than five minutes\.
+ Fewer than two audio connections are present in the meeting for more than 30 minutes\.
+ Screen share viewer connections are inactive for more than 30 minutes\.
+ The meeting time exceeds 24 hours\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-mtgs.md |
6da26506a735-0 | After you complete the [prerequisites](use-bots.md#bots-prereqs), integrate your chatbot with Amazon Chime using the AWS CLI or Amazon Chime API\.
**Note**
These procedures create a name and email address for your chatbot\. Chatbot names and email addresses cannot be changed after creation\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/integrate-bots.md |
aec843adaa65-0 | **To integrate a chatbot using the AWS CLI**
1. To integrate your chatbot with Amazon Chime, use the create\-bot command in the AWS CLI\.
```
aws chime create-bot --account-id 12a3456b-7c89-012d-3456-78901e23fg45 --display-name exampleBot --domain example.com
```
1. Enter a chatbot display name of up to 55 alphanumeric or special characters \(such as \+, \-, %\)\.
1. Enter the registered domain name for your Amazon Chime Enterprise account\.
1. Amazon Chime returns a response that includes the bot ID\.
```
"Bot": {
"CreatedTimestamp": "timeStamp",
"DisplayName": "exampleBot",
"Disabled": exampleBotFlag,
"UserId": "1ab2345c-67de-8901-f23g-45h678901j2k",
"BotId": "botId",
"UpdatedTimestamp": "timeStamp",
"BotType": "ChatBot",
"SecurityToken": "securityToken",
"BotEmail": "displayName-chimebot@example.com"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/integrate-bots.md |
aec843adaa65-1 | "BotEmail": "displayName-chimebot@example.com"
}
```
1. Copy and save the bot ID and bot email address to use in the following procedures\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/integrate-bots.md |
e48c387249cf-0 | **To integrate a chatbot using the Amazon Chime API**
1. To integrate your chatbot with Amazon Chime, use the [CreateBot](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateBot.html) API operation in the *Amazon Chime API Reference*\.
1. Enter a chatbot display name of up to 55 alphanumeric or special characters \(such as \+, \-, %\)\.
1. Enter the registered domain name for your Amazon Chime Enterprise account\.
1. Amazon Chime returns a response that includes the bot ID\. Copy and save the bot ID and email address\. The bot email address looks like this: `exampleBot-chimebot@example.com`\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/integrate-bots.md |
0d831d3c8b89-0 | The following sample code demonstrates how to integrate a chatbot using the AWS SDK for Java\.
```
CreateBotRequest createBotRequest = new CreateBotRequest()
.withAccountId("chimeAccountId")
.withDisplayName("exampleBot")
.withDomain("example.com");
chime.createBot(createBotRequest);
```
Amazon Chime returns a response that includes the bot ID\. Copy and save the bot ID and email address\. The bot email address looks like this: `exampleBot-chimebot@example.com`\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/integrate-bots.md |
2e926299a802-0 | The following example shows how to log out multiple users from your Amazon Chime administrative account\.
```
ListUsersRequest listUsersRequest = new ListUsersRequest()
.withAccountId("chimeAccountId");
ListUsersResult listUsersResult = chime.listUsers(listUsersRequest);
for (User user: listUsersResult.getUsers()) {
LogoutUserRequest logoutUserRequest = new LogoutUserRequest()
.withAccountId(user.getAccountId())
.withUserId(user.getUserId());
chime.logoutUser(logoutUserRequest);
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/logout-users.md |
d13ea543a988-0 | Developers can use the Amazon Chime SDK to build real\-time media applications that can send and receive audio and video and allow content sharing\. The Amazon Chime SDK works independently of any Amazon Chime administrator accounts, and it does not affect meetings hosted on Amazon Chime\. Instead, the Amazon Chime SDK provides builder tools for developers to use to build their own meeting applications\.
**Topics**
+ [Amazon Chime SDK prerequisites](#mtg-prereqs)
+ [Amazon Chime SDK concepts](#mtg-glossary)
+ [Amazon Chime SDK architecture](#mtg-arch)
+ [Amazon Chime SDK quotas](#mtg-limits)
+ [Amazon Chime SDK system requirements](#mtg-browsers)
+ [Integrating with a client library](mtgs-sdk-client-lib.md)
+ [Creating meetings with the Amazon Chime SDK](mtgs-sdk-mtgs.md)
+ [SIP integration using an Amazon Chime Voice Connector](mtgs-sdk-cvc.md)
+ [Amazon Chime SDK event notifications](mtgs-sdk-notifications.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/meetings-sdk.md |
dbd59145f089-0 | Using the Amazon Chime SDK requires the following:
+ The ability to program\.
+ An AWS account\.
+ An IAM role with a policy that grants permission to access Amazon Chime API actions used by the Amazon Chime SDK, such as the AWS managed **AmazonChimeSDK** policy\. For more information, see [How Amazon Chime works with IAM](https://docs.aws.amazon.com/chime/latest/ag/security_iam_service-with-iam.html) and [Allow users to access Amazon Chime SDK actions](https://docs.aws.amazon.com/chime/latest/ag/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-chime-sdk) in the *Amazon Chime Administrator Guide*\.
+ For the majority of use cases, you also need the following:
+ **Server application** – Manages meeting and attendee resources, and serves those resources to the client application\. The server application is created in the AWS account and must have access to the IAM role mentioned previously\.
+ **Client application** – Receives meeting and attendee information from the server application, and uses that information to make media connections\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/meetings-sdk.md |
987ddee16573-0 | The following terminology and concepts are central to understanding how to use the Amazon Chime SDK\.
**meeting**
An ephemeral resource identified by a unique `MeetingId`\. The `MeetingId` is placed onto a group of media services that host the active meeting\.
**media service group**
The group of media services that hosts an active meeting\.
**media placement**
A set of regionalized URLs that represents a media service group\. Attendees connect to the media service group with their clients to send and receive real\-time audio and video, and share their screens\.
**attendee**
A meeting participant that is identified by a unique `AttendeeId`\. Attendees may freely join and leave meetings using a client application built with an Amazon Chime SDK client library\.
**join token**
A unique token assigned to each attendee\. Attendees use the join token to authenticate with the media service group\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/meetings-sdk.md |
6c164742e53a-0 | The following list describes how the different components of the Amazon Chime SDK architecture work together to support meetings and attendees, audio, video, and content sharing\.
**Meetings and attendees**
When the server application creates a meeting using the Amazon Chime SDK, the meeting is assigned to a region\-specific media service group\. The hosts in this group are responsible for securely transferring real\-time media between attendee clients\. Each created attendee is assigned a unique join token, an opaque secret key that your server application must securely transfer to the client authorized to join the meeting on behalf of an attendee\. Each client uses a join token to authenticate with the media service group\. Clients use a combination of secure WebSockets and DTLS to securely signal the media service group, and to send and receive media to and from other attendees through the media service group\.
**Audio**
The media service group mixes audio together from each attendee and sends the mix to each recipient, after subtracting their own audio from the mix\. Audio is sampled at a rate of 16 kHz and encoded using the Opus Codec\.
**Video**
The media service group acts as a Selective Forwarding Unit \(SFU\) using a publish and subscribe model\. Each attendee can publish one video source, up to a total of 16 simultaneous videos per meeting\. Each attendee can also subscribe to all other videos in the meeting except for their own\. Video is sampled at a rate of 15 frames per second and encoded with a variable bitrate codec\.
**Data messages** | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/meetings-sdk.md |
6c164742e53a-1 | **Data messages**
In addition to audio and video content, meeting attendees can send each other real\-time data messages of up to 2 KB each\. Developers can use messages to implement custom meeting features such as whiteboarding, chat, real\-time emoji reactions, and application\-specific floor control signaling\.
**Content sharing**
The client application can share audio and video content, such as screen captures or media files\. Each content share appears in the meeting as an additional attendee\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/meetings-sdk.md |
e46cfe75ba54-0 | | Resource | Quota |
| --- | --- |
| Attendees per meeting | 250 |
| Audio streams per meeting | 250 |
| Video streams per meeting | 16 |
| Content shares per meeting | 2 |
Video resolution up to 1280x720 is supported, depending on CPU and bandwidth availability\. Video limits are dependent on camera capabilities\. For more information, see [Bandwidth requirements](https://docs.aws.amazon.com/chime/latest/ag/network-config.html#bandwidth) in the *Amazon Chime Administrator Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/meetings-sdk.md |
52efc7e9c464-0 | The following system requirements apply to applications created with the Amazon Chime SDK\.
**Amazon Chime SDK for JavaScript – Supported browsers**
+ Mozilla Firefox \(version 60 and later\), for macOS and Windows
+ Google Chrome \(version 78 and later\), for macOS, Windows, and Ubuntu LTS 16\.04 and later
+ Google Chrome for Android also supported for audio and video only \(no content sharing\)
+ Chromium\-based Edge \(version 79 and later\), for Windows
+ Chromium\-based Electron \(Electron 7 and later, with Chromium version 78 and later\)
+ Safari \(version 12, audio and video only, no content sharing\), for macOS
+ Safari \(version 12\.1\.1 and later, audio and video only, no content sharing\), for iOS
+ Safari \(version 13 and later, content sharing with screen capture requires turning on the **Develop**, **Experimental Features**, **Screen Capture** feature in the browser\), for macOS
+ Opera \(version 66 and later\), for macOS and Windows
**Amazon Chime SDK for iOS**
+ iOS \(version 10\.0 and later\)
**Amazon Chime SDK for Android**
+ Android OS \(version 5\.0 and later, ARM and ARM64 architecture\) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/meetings-sdk.md |
d3a55e032b3d-0 | The following example shows how to invite multiple users to an Amazon Chime `Team` account\.
```
List<String> emails = new ArrayList<>();
emails.add("janedoe@example.com");
emails.add("richardroe@example.net");
InviteUsersRequest inviteUsersRequest = new InviteUsersRequest()
.withAccountId("chimeAccountId")
.withUserEmailList(emails);
chime.inviteUsers(inviteUsersRequest);
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/invite-users.md |
f66753ca1dc5-0 | Developers can use the AWS Command Line Interface \(AWS CLI\), Amazon Chime API, or AWS SDK to integrate chatbots with Amazon Chime\. Chatbots let you use the power of Amazon Lex, AWS Lambda, and other AWS services to streamline common tasks with intelligent conversational interfaces that are accessible to users in Amazon Chime chat rooms\.
If you're an Amazon Chime Enterprise account administrator, you can use chatbots to allow users to perform such tasks as:
+ Querying their internal systems for information\.
+ Automating tasks\.
+ Receiving notifications for critical issues\.
+ Creating support tickets\.
For more information about Amazon Chime Enterprise accounts, see [Managing your Amazon Chime accounts](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the *Amazon Chime Administrator Guide*\.
If you administer an Amazon Chime Enterprise account, you can create up to 10 chatbots for integration with Amazon Chime\. Chatbots can be used only in chat rooms created by members of your account\. Only chat room administrators can add chatbots to a chat room\. After a chatbot is added to a chat room, members of the chat room can interact with the bot using commands provided by the bot creator\. For more information, see [Using chatbots](https://docs.aws.amazon.com/chime/latest/ug/chat-bots.html) in the *Amazon Chime User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/chat-bots.md |
f66753ca1dc5-1 | Linux and macOS users can build a sample custom chatbot\. For more information, see [Build custom chatbots for Amazon Chime](http://aws.amazon.com/blogs/business-productivity/build-custom-chat-bots-for-amazon-chime/)\.
**Topics**
+ [Use chatbots with Amazon Chime](use-bots.md)
+ [Amazon Chime events sent to chatbots](events-bots.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/chat-bots.md |
1edd94f963fc-0 | The following table describes important changes to the *Amazon Chime Developer Guide*, beginning in September 2019\. For notifications about updates to this documentation, you can subscribe to an RSS feed\.
| Change | Description | Date |
| --- |--- |--- |
| [Proxy phone sessions](#doc-history) | Developers can create proxy phone sessions for use with Amazon Chime Voice Connectors\. For more information, see [Proxy phone sessions](https://docs.aws.amazon.com/chime/latest/dg/proxy-phone-sessions.html) in the *Amazon Chime Developer Guide*\. | April 7, 2020 |
| [Amazon Chime SDK content sharing](#doc-history) | The Amazon Chime SDK supports content sharing\. For more information, see [Amazon Chime SDK architecture](https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html#mtg-arch) in the *Amazon Chime Developer Guide*\. | March 31, 2020 |
| [Amazon Chime SDK for Android and iOS](#doc-history) | The Amazon Chime SDK for Android and iOS is released\. For more information, see [Integrating with a client library](https://docs.aws.amazon.com/chime/latest/dg/mtgs-sdk-client-lib.html) in the *Amazon Chime Developer Guide*\. | March 24, 2020 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/doc-history.md |
1edd94f963fc-1 | | [Amazon Chime SDK](#doc-history) | The Amazon Chime SDK is released\. For more information, see [Using the Amazon Chime SDK](https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the *Amazon Chime Developer Guide*\. | November 20, 2019 |
| [Amazon Chime Developer Guide](#doc-history) | The *Amazon Chime Developer Guide* is released\. | September 11, 2019 | | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/doc-history.md |
c87c7560f483-0 | Only a chat room administrator can add a chatbot to a chat room\. They use the chatbot email address created in [Step 1](integrate-bots.md)\.
**To add a chatbot to a chat room**
1. Open the Amazon Chime desktop client or web application\.
1. Choose the gear icon in the upper\-right corner, and choose **Manage webhooks and bots**\.
1. Choose **Add bot**\.
1. For **Email address**, enter the bot email address\.
1. Choose **Add**\.
The bot name appears in the chat room roster\. If there are additional instructions necessary to add a chatbot to a chat room, provide the instructions to the chat room administrator\.
After the chatbot is added to the chat room, provide the chatbot commands to your chat room users\. One way to do this is to program your chatbot to send command help to the chat room when it receives the chat room invite\. AWS also recommends creating a help command for your chatbot users to use\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/add-bots.md |
9589985a0900-0 | We recommend specifying an AWS Region for your Amazon Chime SDK meeting using the `MediaRegion` parameter in the `CreateMeeting` API action\. Available media Regions for Amazon Chime SDK meetings include the following:
+ US East \(Ohio\) \(us\-east\-2\)
+ US East \(N\. Virginia\) \(us\-east\-1\)
+ US West \(N\. California\) \(us\-west\-1\)
+ US West \(Oregon\) \(us\-west\-2\)
+ Asia Pacific \(Singapore\) \(ap\-southeast\-1\)
+ Asia Pacific \(Sydney\) \(ap\-southeast\-2\)
+ Asia Pacific \(Tokyo\) \(ap\-northeast\-1\)
+ Canada \(Central\) \(ca\-central\-1\)
+ Europe \(Frankfurt\) \(eu\-central\-1\)
+ Europe \(Ireland\) \(eu\-west\-1\)
+ Europe \(London\) \(eu\-west\-2\)
+ Europe \(Paris\) \(eu\-west\-3\)
+ Europe \(Stockholm\) \(eu\-north\-1\)
+ South America \(São Paulo\) \(sa\-east\-1\) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/chime-sdk-meetings-regions.md |
9589985a0900-1 | + South America \(São Paulo\) \(sa\-east\-1\)
For more information about available media Regions, see the `MediaRegion` definition for [CreateMeeting](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateMeeting.html#API_CreateMeeting_RequestBody) in the *Amazon Chime API Reference*\.
**Note**
The preceding media Regions are used for hosting Amazon Chime SDK meetings\. This differs from the Amazon Chime API, which has a single endpoint\. For more information, see [Amazon Chime endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/chime.html) in the *Amazon Web Services General Reference*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/chime-sdk-meetings-regions.md |
7c47090ab544-0 | When choosing a media Region to use for your Amazon Chime SDK meeting, common factors to consider include the following:
**Regulatory requirements**
If your Amazon Chime SDK meetings are subject to regulations requiring them to be hosted within a geopolitical border, consider hardcoding the meeting Region based on fixed application logic\.
For example, a telemedicine application might require all meetings to be hosted within the medical practitioner's jurisdiction\. If the application supports clinics located in both Europe and the United States, you can use each clinic's address to select a Region within its jurisdiction\.
**Meeting quality**
When an Amazon Chime SDK meeting is hosted in a media Region, each attendee's audio and video is sent and received from that Region\. As the distance between the attendee and the Region increases, meeting quality can be affected by network latency\. Specifying a Region for your Amazon Chime SDK meeting can help enhance the meeting quality for your attendees, whether they are located near each other or distributed geographically\.
You can use one of the following methods to choose a media Region for your Amazon Chime SDK meeting:
**Hardcode a media Region**
Recommended if your Amazon Chime SDK meetings are all hosted within a specific AWS Region\.
**Choose the nearest media Region**
Recommended if your Amazon Chime SDK meeting attendees are located in the same AWS Region, but your meetings are hosted in different Regions\.
For more details about choosing the nearest media Region, see the following topic\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/chime-sdk-meetings-regions.md |
b14bb445d7e2-0 | Call `https://nearest-media-region.l.chime.aws` to identify the nearest media Region that can host your Amazon Chime SDK meeting\. Make the call from the client application, not the server application\. Pass the call to the application before your attendees need to join the meeting, such as at the time that the application starts up\.
Your request returns a JSON object showing the AWS Region that is nearest to you\.
**Example : Call to `https://nearest-media-region.l.chime.aws`**
The following example shows the contents of a request sent to `https://nearest-media-region.l.chime.aws` to identify the nearest media Region\.
```
async getNearestMediaRegion(): Promise<string> {
var nearestMediaRegion = '';
const defaultMediaRegion = 'us-east-1';
try {
const nearestMediaRegionResponse = await fetch(
`https://nearest-media-region.l.chime.aws`,
{
method: 'GET',
}
);
const nearestMediaRegionJSON = await nearestMediaRegionResponse.json();
this.log(nearestMediaRegionJSON.region);
nearestMediaRegion = nearestMediaRegionJSON.region;
} catch (error) {
nearestMediaRegion = defaultMediaRegion; | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/chime-sdk-meetings-regions.md |
b14bb445d7e2-1 | nearestMediaRegion = nearestMediaRegionJSON.region;
} catch (error) {
nearestMediaRegion = defaultMediaRegion;
this.log('Default media region ' + defaultMediaRegion + ' selected: ' + error.message);
} finally {
return nearestMediaRegion;
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/chime-sdk-meetings-regions.md |
0ad90415dbb6-0 | You can authenticate requests sent to your chatbot from an Amazon Chime chat room\. To do this, compute a signature based on the request\. Then, validate that the computed signature matches the one on the request header\. Amazon Chime uses the HMAC SHA256 hash to generate the signature\.
If your chatbot is configured for Amazon Chime using an outbound HTTPS endpoint, use the following authentication steps\.
**To validate a signed request from Amazon Chime for a chatbot with a outbound HTTPS endpoint configured**
1. Get the **Chime\-Signature** header from the HTTP request\.
1. Get the **Chime\-Request\-Timestamp** header and the **body** of the request\. Then, use a vertical bar as the delimiter between the two elements to form a string\.
1. Use the **SecurityToken** from the CreateBot response as the initial key of **HMAC\_SHA\_256**, and hash the string that you created in step 2\.
1. Encode the hashed byte with Base64 encoder to a signature string\.
1. Compare this computed signature to the one in the **Chime\-Signature** header\.
The following code sample demonstrates how to generate a signature using Java\.
```
private final String DELIMITER = "|";
private final String HMAC_SHA_256 = "HmacSHA256";
private String generateSignature(String securityToken, String requestTime, String requestBody)
{ | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/auth-bots.md |
0ad90415dbb6-1 | private String generateSignature(String securityToken, String requestTime, String requestBody)
{
try {
final Mac mac = Mac.getInstance(HMAC_SHA_256);
SecretKeySpec key = new SecretKeySpec(securityToken.getBytes(UTF_8), HMAC_SHA_256);
mac.init(key);
String data = requestTime + DELIMITER + requestBody;
byte[] rawHmac = mac.doFinal(data.getBytes(UTF_8));
return Base64.getEncoder().encodeToString(rawHmac);
}
catch (Exception e) {
throw e;
}
}
```
The outbound HTTPS endpoint must respond to the Amazon Chime request with `200 OK` within 2 seconds\. Otherwise, the request fails\. If the outbound HTTPS endpoint is unavailable after 2 seconds, possibly because of a Connection or Read timeout, , or if Amazon Chime receives a 5xx response code, Amazon Chime retries the request two times\. The first retry is sent 200 milliseconds after the initial request fails\. The second retry is sent 400 milliseconds after the previous retry fails\. If the outbound HTTPS endpoint is still unavailable after the second retry, the request fails\.
**Note**
The **Chime\-Request\-Timestamp** changes each time the request is retried\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/auth-bots.md |
0ad90415dbb6-2 | **Note**
The **Chime\-Request\-Timestamp** changes each time the request is retried\.
If your chatbot is configured for Amazon Chime using a Lambda function ARN, use the following authentication steps\.
**To validate a signed request from Amazon Chime for a chatbot with a Lambda function ARN configured**
1. Get the **Chime\-Signature** and **Chime\-Request\-Timestamp** from the Lambda request **ClientContext**, in Base64 encoded JSON format\.
```
{
"Chime-Signature" : "1234567890",
"Chime-Request-Timestamp" : "2019-04-04T21:30:43.181Z"
}
```
1. Get the **body** of the request from the request payload\.
1. Use the **SecurityToken** from the `CreateBot` response as the initial key of **HMAC\_SHA\_256**, and hash the string that you created\.
1. Encode the hashed byte with Base64 encoder to a signature string\.
1. Compare this computed signature to the one in the **Chime\-Signature** header\.
If a `com.amazonaws.SdkClientException` occurs during the Lambda invocation, Amazon Chime retries the request two times\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/auth-bots.md |
5a8799ce6a3b-0 | -----
*****Copyright © 2020 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.*****
-----
Amazon's trademarks and trade dress may not be used in
connection with any product or service that is not Amazon's,
in any manner that is likely to cause confusion among customers,
or in any manner that disparages or discredits Amazon. All other
trademarks not owned by Amazon are the property of their respective
owners, who may or may not be affiliated with, connected to, or
sponsored by Amazon.
----- | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/index.md |
edf03a18d610-0 | + [What is Amazon Chime?](what-is-chime.md)
+ [User management](users.md)
+ [Invite multiple users](invite-users.md)
+ [Download user list](download-users.md)
+ [Log out multiple users](logout-users.md)
+ [Update user personal PINs](update-pins.md)
+ [Amazon Chime chatbots](chat-bots.md)
+ [Use chatbots with Amazon Chime](use-bots.md)
+ [Step 1: Integrate a chatbot with Amazon Chime](integrate-bots.md)
+ [Step 2: Configure the outbound endpoint for an Amazon Chime chatbot](config-endpoints.md)
+ [Step 3: Add the chatbot to an Amazon Chime chat room](add-bots.md)
+ [Authenticate chatbot requests](auth-bots.md)
+ [Update chatbots](update-bots.md)
+ [Amazon Chime events sent to chatbots](events-bots.md)
+ [Proxy phone sessions](proxy-phone-sessions.md)
+ [Webhooks for Amazon Chime](webhooks.md)
+ [Using the Amazon Chime SDK](meetings-sdk.md)
+ [Integrating with a client library](mtgs-sdk-client-lib.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/index.md |
edf03a18d610-1 | + [Integrating with a client library](mtgs-sdk-client-lib.md)
+ [Creating meetings with the Amazon Chime SDK](mtgs-sdk-mtgs.md)
+ [Amazon Chime SDK media Regions](chime-sdk-meetings-regions.md)
+ [SIP integration using an Amazon Chime Voice Connector](mtgs-sdk-cvc.md)
+ [Amazon Chime SDK event notifications](mtgs-sdk-notifications.md)
+ [Document history](doc-history.md)
+ [AWS glossary](glossary.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/index.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.