id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
174bd035771d-0 | After you create a chatbot ID for your Amazon Chime Enterprise account, configure your outbound endpoint for Amazon Chime to use to send messages to your bot\. The outbound endpoint can be an AWS Lambda function ARN or an HTTPS endpoint that you created as part of the [prerequisites](use-bots.md#bots-prereqs)\. For more information about Lambda, see the *[AWS Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/)*\.
**Note**
If the outbound HTTPS endpoint for your bot is not configured or is empty, chat room administrators cannot add the bot to a chat room\. Also, chat room users cannot interact with the bot\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
5e3def894525-0 | To configure an outbound endpoint for your chatbot, use the put\-events\-configuration command in the AWS CLI\. Configure a Lambda function ARN or an outbound HTTPS endpoint\.
------ | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
4f4fa23bcae6-0 | ```
aws chime put-events-configuration --account-id 12a3456b-7c89-012d-3456-78901e23fg45 --bot-id botId --lambda-function-arn arn:aws:lambda:us-east-1:111122223333:function:function-name
```
------ | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
a585106346fe-0 | ```
aws chime put-events-configuration --account-id 12a3456b-7c89-012d-3456-78901e23fg45 --bot-id botId --outbound-events-https-endpoint https://example.com:8000
```
------
Amazon Chime responds with the bot ID and HTTPS endpoint\.
```
{
"EventsConfiguration": {
"BotId": "BotId",
"OutboundEventsHTTPSEndpoint": "https://example.com:8000"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
b8d262a21b5d-0 | To configure the outbound endpoint for your chatbot, use the Amazon Chime [PutEventsConfiguration](https://docs.aws.amazon.com/chime/latest/APIReference/API_PutEventsConfiguration.html) API operation in the *Amazon Chime API Reference*\. Configure either a Lambda function ARN or an outbound HTTPS endpoint\.
+ **If you configure a Lambda function ARN** – Amazon Chime calls Lambda to add permission to allow the Amazon Chime administrator's AWS account to invoke the provided Lambda function ARN\. This is followed by a dry run invocation to verify that Amazon Chime has permission to invoke the function\. If adding permissions fails, or if the dry run invocation fails, then the `PutEventsConfiguration` request returns an HTTP 4xx error\.
+ **If you configure an outbound HTTPS endpoint** – Amazon Chime verifies your endpoint by sending an HTTP Post request with a Challenge JSON payload to the outbound HTTPS endpoint that you provided in the previous step\. Your outbound HTTPS endpoint must respond by echoing back the Challenge parameter in JSON format\. The following examples show the request and a valid response\.
------ | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
a609c7857c73-0 | ```
HTTPS POST
JSON Payload:
{
"Challenge":"00000000000000000000",
"EventType" : "HTTPSEndpointVerification"
}
```
------ | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
89e45bd03ec7-0 | ```
HTTP/1.1 200 OK
Content-type: application/json
{
"Challenge":"00000000000000000000"
}
```
------
If the challenge handshake fails, then the `PutEventsConfiguration` request returns an HTTP 4xx error\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
bd4cb031c6c6-0 | The following sample code demonstrates how to configure an endpoint using the AWS SDK for Java\.
```
PutEventsConfigurationRequest putEventsConfigurationRequest = new PutEventsConfigurationRequest()
.withAccountId("chimeAccountId")
.withBotId("botId")
.withOutboundEventsHTTPSEndpoint("https://www.example.com")
.withLambdaFunctionArn("arn:aws:lambda:region:account-id:function:function-name");
chime.putEventsConfiguration(putEventsConfigurationRequest):
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/config-endpoints.md |
f8a2b7d6ee4c-0 | Incoming webhooks that you create can programmatically send messages to Amazon Chime chat rooms\. For example, a webhook can notify a customer service team about the creation of a new high\-priority ticket, and add a link to the ticket in the chat room\.
Webhooks messages can be formatted with markdown and can include emojis\. HTTP links and email addresses render as active links\. Messages can also include @All and @Present annotations to alert all members and present members of a chat room, respectively\. To directly @mention a chat room participant, use their alias or full email address\. For example, @`alias` or @`[email protected]`\.
Webhooks can only be part of a chat room and can't be shared\. Amazon Chime chat room administrators can add up to 10 webhooks for each chat room\.
After you create a webhook, you can integrate it with an Amazon Chime chat room, as shown in the following procedure\.
**To integrate a webhook with a chat room**
1. Get the webhook URL from the chat room administrator\. For more information, see [Adding webhooks to chat rooms](https://docs.aws.amazon.com/chime/latest/ug/webhooks.html) in the *Amazon Chime User Guide*\.
1. Use the webhook URL in the script or application that you created to send messages to the chat room:
1. The URL accepts an HTTP POST request\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/webhooks.md |
f8a2b7d6ee4c-1 | 1. The URL accepts an HTTP POST request\.
1. Amazon Chime webhooks accept a JSON payload with a single key **Content**\. The following is a sample curl command with a sample payload:
```
curl -X POST "<Insert your webhook URL here>" -H "Content-Type:application/json" --data '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: [email protected] All member callout: @All All Present member callout: @Present"}'
```
The following is a sample PowerShell command for Windows users:
```
Invoke-WebRequest -Uri '<Insert your webhook URL here>' -Method 'Post' -ContentType 'application/JSON' -Body '{"Content":"Message Body emoji test: :) :+1: link test: http://sample.com email test: [email protected] All member callout: @All All Present member callout: @Present"}'
```
After the external program sends the HTTP POST to the webhook URL, the server validates that the webhook is valid and has an assigned chat room\. The webhook appears in the chat room roster with a webhook icon next to its name\. Chat room messages sent by the webhook appear in the chat room under the webhook name followed by **\(Webhook\)**\.
**Note** | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/webhooks.md |
f8a2b7d6ee4c-2 | **Note**
CORS is not currently enabled for webhooks\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/webhooks.md |
88098a7c878d-0 | The following is a list of webhook\-related errors:
+ The incoming webhook rate limit for each webhook is 1 TPS per chat room\. Throttling results in an HTTP 429 error\.
+ Messages posted by a webhook must be 4 KB or less\. A bigger message payload results in an HTTP 413 error\.
+ Messages posted by a webhook with @All and @Present annotations work only for chat rooms with 50 or fewer members\. More than 50 members results in an HTTP 400 error\.
+ If the webhook URL is regenerated, using the old URL results in an HTTP 404 error\.
+ If the webhook in a room is deleted, using the old URL results in an HTTP 404 error\.
+ Invalid webhook URLs result in HTTP 403 errors\.
+ If the service is unavailable, the user receives an HTTP 503 error in the response\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/webhooks.md |
cd47415f8d77-0 | Integrate your SIP\-compatible voice infrastructure with an Amazon Chime Voice Connector to make SIP voice calls\. You must have an IP Private Branch Exchange \(PBX\), Session Border Controller \(SBC\), or other voice infrastructure with internet access that supports Session Initiation Protocol \(SIP\)\. For more information, see [Before you begin](https://docs.aws.amazon.com/chime/latest/ag/voice-connectors.html#vc-prereq) in the *Amazon Chime Administrator Guide*\.
**To integrate your voice infrastructure with an Amazon Chime Voice Connector**
1. Create an Amazon Chime Voice Connector under your AWS account\. For more information, see [Creating an Amazon Chime Voice Connector](https://docs.aws.amazon.com/chime/latest/ag/voice-connectors.html#create-voicecon) in the *Amazon Chime Administrator Guide*\.
1. Edit your Amazon Chime Voice Connector settings to allow calling from your voice infrastructure to AWS\. For more information, see [Editing Amazon Chime Voice Connector settings](https://docs.aws.amazon.com/chime/latest/ag/voice-connectors.html#edit-voicecon) in the *Amazon Chime Administrator Guide*\.
1. For **Termination settings**, select **Enabled**\.
1. For **Allowlist**, choose **New**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-cvc.md |
cd47415f8d77-1 | 1. For **Allowlist**, choose **New**\.
1. Enter the CIDR notations of the IP addresses for your internal SIP infrastructure\. This allows your infrastructure to access the Amazon Chime Voice Connector\. For example, to allow traffic from IP address `10.24.34.0`, allowlist the CIDR notation `10.24.34.0/32`\.
1. Choose **Add**\.
1. For **Calling plan**, select the country or countries to add to your calling plan\.
1. Edit any other settings as needed, and choose **Save**\.
1. In the Amazon Chime console, under **Voice connectors**, view the **Outbound host name** for your Amazon Chime Voice Connector\. For example, *abcdef1ghij2klmno3pqr4*\.voiceconnector\.chime\.aws\.
1. To join a meeting using the Amazon Chime SDK, use a SIP URI to make a SIP request to the **Outbound host name** of your Amazon Chime Voice Connector\. Use phone number **\+17035550122** in the SIP URI\. Set the `transport` parameter to use the TLS protocol\. Finally, use the unique join token generated by calling the [CreateAttendee](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html) API action\. For more information, see the following example\.
**Example Example: SIP request** | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-cvc.md |
cd47415f8d77-2 | **Example Example: SIP request**
The following example shows the contents of a SIP URI used to make a SIP request to an Amazon Chime Voice Connector\.
```
sip:[email protected];transport=tls;X-chime-join-token=join-token
```
The following example shows a sample SIP INVITE message to join an Amazon Chime SDK meeting\.
```
INVITE sip:[email protected];transport=tls;X-chime-join-token=join-token SIP/2.0
Via: SIP/2.0/TLS IPaddress:12345;rport;branch=branch;alias
Max-Forwards: 70
From: sip:+12065550100@IPaddress;tag=tag
To: sip:[email protected];X-chime-join-token=join-token
Contact: <sip:+12065550100@IPaddress:54321;transport=TLS;ob>
Call-ID: a1234567-89b0-1c2d-e34f-5gh678j9k2lm
CSeq: 6214 INVITE | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-cvc.md |
cd47415f8d77-3 | CSeq: 6214 INVITE
Allow: PRACK, INVITE, ACK, BYE, CANCEL, UPDATE, INFO, SUBSCRIBE, NOTIFY, REFER, MESSAGE, OPTIONS
Supported: replaces, 100rel, timer, norefersub
Session-Expires: 1800
Min-SE: 90
Content-Type: application/sdp
Content-Length: 991
v=0
o=- 3775321410 3775321410 IN IP4 IPaddress
s=pjmedia
b=AS:117
t=0 0
a=X-nat:0
m=audio 4000 RTP/SAVP 0 3 8 9 125 101
c=IN IP4 IPaddress
b=TIAS:96000
a=rtcp:4001 IN IP4 IPaddress
a=sendrecv
a=rtpmap:0 PCMU/8000
a=rtpmap:3 GSM/8000
a=rtpmap:8 PCMA/8000
a=rtpmap:9 G722/8000
a=rtpmap:125 opus/48000/2
a=fmtp:125 useinbandfec=1
a=rtpmap:101 telephone-event/8000
a=fmtp:101 0-16
a=crypto:1 AEAD_AES_256_GCM inline:EXAMPLE | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-cvc.md |
cd47415f8d77-4 | a=fmtp:101 0-16
a=crypto:1 AEAD_AES_256_GCM inline:EXAMPLE
a=crypto:2 AEAD_AES_256_GCM_8 inline:EXAMPLE
a=crypto:3 AES_256_CM_HMAC_SHA1_80 inline:EXAMPLE
a=crypto:4 AES_256_CM_HMAC_SHA1_32 inline:EXAMPLE
a=crypto:5 AES_CM_128_HMAC_SHA1_80 inline:EXAMPLE
a=crypto:6 AES_CM_128_HMAC_SHA1_32 inline:EXAMPLE
```
**Note**
Amazon Chime recognizes phone numbers only in E\.164 format\. Make sure that an E\.164 phone number is in your `From` header\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-cvc.md |
802d5371e7f3-0 | Amazon Chime is a communications service that transforms online meetings with an application that is secure and comprehensive\. Amazon Chime works across your devices so that you can stay connected\. You can use Amazon Chime for online meetings, video conferencing, calls, and chat\. You can also share content inside and outside of your organization\. Amazon Chime helps you to work productively from anywhere\.
Developers can use Amazon Chime with the AWS SDK or AWS Command Line Interface \(AWS CLI\) to perform such tasks as managing users, or integrating webhooks and chat bots with Amazon Chime\. They can also use the Amazon Chime SDK to build real\-time media applications that can send and receive audio and video and allow content sharing\. For detailed information about Amazon Chime API actions, see the [https://docs.aws.amazon.com/chime/latest/APIReference/Welcome.html](https://docs.aws.amazon.com/chime/latest/APIReference/Welcome.html)\.
Amazon Chime permissions are controlled using AWS Identity and Access Management \(IAM\)\. For more information, see [Identity and access management for Amazon Chime](https://docs.aws.amazon.com/chime/latest/ag/security-iam.html) in the *Amazon Chime Administrator Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/what-is-chime.md |
6367340d4657-0 | Amazon Chime provides usage\-based pricing\. You pay only for the users with Pro permissions that host meetings, and only on the days that those meetings are hosted\. For more information, see [Amazon Chime pricing](http://aws.amazon.com/chime/pricing/)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/what-is-chime.md |
1ae18fdb81bf-0 | The following related resources can help you as you work with this service\.
+ ** [Classes & Workshops](https://aws.amazon.com/training/course-descriptions/)** – Links to role\-based and specialty courses as well as self\-paced labs to help sharpen your AWS skills and gain practical experience\.
+ ** [AWS Developer Tools](https://aws.amazon.com/tools/)** – Links to developer tools, SDKs, IDE toolkits, and command line tools for developing and managing AWS applications\.
+ ** [AWS Whitepapers](https://aws.amazon.com/whitepapers/)** – Links to a comprehensive list of technical AWS whitepapers, covering topics such as architecture, security, and economics and authored by AWS Solutions Architects or other technical experts\.
+ ** [AWS Support Center](https://console.aws.amazon.com/support/home#/)** – The hub for creating and managing your AWS Support cases\. Also includes links to other helpful resources, such as forums, technical FAQs, service health status, and AWS Trusted Advisor\.
+ ** [AWS Support](https://aws.amazon.com/premiumsupport/)** – The primary web page for information about AWS Support, a one\-on\-one, fast\-response support channel to help you build and run applications in the cloud\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/what-is-chime.md |
1ae18fdb81bf-1 | + ** [Contact Us](https://aws.amazon.com/contact-us/)** – A central contact point for inquiries concerning AWS billing, account, events, abuse, and other issues\.
+ ** [AWS Site Terms](https://aws.amazon.com/terms/)** – Detailed information about our copyright and trademark; your account, license, and site access; and other topics\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/what-is-chime.md |
4c42ca761e07-0 | If you administer an Amazon Chime Enterprise account, you can create up to 10 chatbots for integration with Amazon Chime\. Chatbots can only be used 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*\.
You can also use the Amazon Chime API operation to enable or stop chatbots for your Amazon Chime account\. For more information, see [Update chatbots](update-bots.md)\.
**Note**
Chatbots cannot be deleted\. To stop a chatbot from being used in your account, use the Amazon Chime [UpdateBot](https://docs.aws.amazon.com/chime/latest/APIReference/API_UpdateBot.html) API operation in the *Amazon Chime API Reference*\. When you stop a chatbot, chat room administrators can remove it from a chat room, but they cannot add it to a chat room\. Users who @mention a stopped chatbot in a chat room receive an error message\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/use-bots.md |
4e5093a67622-0 | Before you start the procedure to integrate chatbots with Amazon Chime, complete the following prerequisites:
+ Create a chatbot\.
+ Create the outbound endpoint for Amazon Chime to send events to your bot\. Choose from an AWS Lambda function ARN or an HTTPS endpoint\. For more information about Lambda, see the *[AWS Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/)*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/use-bots.md |
83164bb1e84e-0 | We recommend the following best practices when assigning DNS for your HTTPS endpoint:
+ Use a DNS subdomain that is dedicated to the bot endpoint\.
+ Use only A\-records to point to the bot endpoint\.
+ Protect your DNS servers and DNS registrar account to prevent domain hijacking\.
+ Use publicly valid TLS intermediate certificates that are dedicated to the bot endpoint\.
+ Cryptographically verify the bot message signature before acting on a bot message\.
After creating your chatbot, use the AWS Command Line Interface \(AWS CLI\) or the Amazon Chime API operation to complete the tasks described in the following sections\.
**Topics**
+ [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) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/use-bots.md |
65f724a9cf18-0 | The Amazon Chime SDK supports sending meeting event notifications to Amazon EventBridge, Amazon Simple Queue Service \(Amazon SQS\), and Amazon Simple Notification Service \(Amazon SNS\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-notifications.md |
c396723bb5a2-0 | We recommend sending Amazon Chime SDK event notifications to EventBridge\. For detailed information about using the Amazon Chime SDK with EventBridge, see [Automating the Amazon Chime SDK with EventBridge](https://docs.aws.amazon.com/chime/latest/ag/automating-chime-with-cloudwatch-events.html#events-sdk) in the *Amazon Chime Administrator Guide*\. For information about EventBridge, see the [Amazon EventBridge User Guide](https://docs.aws.amazon.com/eventbridge/latest/userguide/)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-notifications.md |
c988324bafeb-0 | You can use the [CreateMeeting](https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateMeeting.html) API in the *Amazon Chime API Reference* to send Amazon Chime SDK meeting event notifications to one Amazon SQS queue and one Amazon SNS topic per meeting\. This can help reduce notification latency\. For more information about Amazon SQS, see the [Amazon Simple Queue Service Developer Guide](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/)\. For more information about Amazon SNS, see the [Amazon Simple Notification Service Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/)\.
The notifications sent to Amazon SQS and Amazon SNS contain the same information as the notifications that Amazon Chime sends to EventBridge\. The Amazon Chime SDK supports sending meeting event notifications to queues and topics in the US East \(N\. Virginia\) \(**us\-east\-1**\) AWS Region\. Event notifications might be delivered out of order of occurrence\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-notifications.md |
f8a6f42f45d6-0 | If you have an Amazon SQS queue or Amazon SNS topic configured in the **us\-east\-1** Region and you want to send Amazon Chime SDK events to it, you must grant the Amazon Chime SDK permission to publish messages to the Amazon Resource Name \(ARN\) of the queue or topic\. To do this, attach an AWS Identity and Access Management \(IAM\) policy to the queue or topic that grants the appropriate permissions to the Amazon Chime SDK\. For more information, see [Identity and access management in Amazon SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html) in the *Amazon Simple Queue Service Developer Guide* and [Example cases for Amazon SNS access control ](https://docs.aws.amazon.com/sns/latest/dg/sns-access-policy-use-cases.html) in the *Amazon Simple Notification Service Developer Guide*\.
**Example : Allow the Amazon Chime SDK to publish events to an Amazon SQS queue**
The following example IAM policy grants the Amazon Chime SDK permission to publish meeting event notifications to the specified Amazon SQS queue\.
```
{
"Version": "2008-10-17",
"Id": "example-ID",
"Statement": [
{
"Sid": "example-statement-ID",
"Effect": "Allow",
"Principal": { | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-notifications.md |
f8a6f42f45d6-1 | {
"Sid": "example-statement-ID",
"Effect": "Allow",
"Principal": {
"Service": "chime.amazonaws.com"
},
"Action": [
"sqs:SendMessage",
"sqs:GetQueueUrl"
],
"Resource": "arn:aws:sqs:us-east-1:111122223333:queueName",
}
]
}
```
If the Amazon SQS queue is enabled for server\-side encryption \(SSE\), you must take an additional step\. Attach an IAM policy to the associated AWS KMS key that grants the Amazon Chime SDK permission to the AWS KMS actions needed to encrypt data added to the queue\.
```
{
"Version": "2012-10-17",
"Id": "example-ID",
"Statement": [
{
"Sid": "example-statement-ID",
"Effect": "Allow",
"Principal": {
"Service": "chime.amazonaws.com"
},
"Action": [
"kms:GenerateDataKey",
"kms:Decrypt"
], | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-notifications.md |
f8a6f42f45d6-2 | "Action": [
"kms:GenerateDataKey",
"kms:Decrypt"
],
"Resource": "*"
}
]
}
```
**Example : Allow the Amazon Chime SDK to publish events to an Amazon SNS topic**
The following example IAM policy grants the Amazon Chime SDK permission to publish meeting event notifications to the specified Amazon SNS topic\.
```
{
"Version": "2008-10-17",
"Id": "example-ID",
"Statement": [
{
"Sid": "allow-chime-sdk-access-statement-id",
"Effect": "Allow",
"Principal": {
"Service": "chime.amazonaws.com"
},
"Action": [
"SNS:Publish"
],
"Resource": "arn:aws:sns:us-east-1:111122223333:topicName"
}
]
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/mtgs-sdk-notifications.md |
75facecea2b9-0 | As the Amazon Chime account administrator, you can use the Amazon Chime API with the AWS SDK or AWS CLI to view your chatbot details\. You can also enable or stop your chatbots from being used in your account\. You can also regenerate security tokens for your chatbot\.
For more information, see the following topics in the *Amazon Chime API Reference*:
+ [GetBot](https://docs.aws.amazon.com/chime/latest/APIReference/API_GetBot.html) – Gets your chatbot details, such as bot email address and bot type\.
+ [UpdateBot](https://docs.aws.amazon.com/chime/latest/APIReference/API_UpdateBot.html) – Enables or stops a chatbot from being used in your account\.
+ [RegenerateSecurityToken](https://docs.aws.amazon.com/chime/latest/APIReference/API_RegenerateSecurityToken.html) – Regenerates the security token for your chatbot\.
You can also change the `PutEventsConfiguration` for your chatbot\. For example, if your chatbot was initially configured to use an outbound HTTPS endpoint, you can delete the previous events configuration and put a new events configuration for a Lambda function ARN\.
For more information, see the following topics in the *Amazon Chime API Reference*: | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/update-bots.md |
75facecea2b9-1 | For more information, see the following topics in the *Amazon Chime API Reference*:
+ [DeleteEventsConfiguration](https://docs.aws.amazon.com/chime/latest/APIReference/API_DeleteEventsConfiguration.html)
+ [PutEventsConfiguration](https://docs.aws.amazon.com/chime/latest/APIReference/API_PutEventsConfiguration.html) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-chime-developer-guide/doc_source/update-bots.md |
44506f76604b-0 | After an app is connected to a custom domain in Route 53, Amplify Console enables you to automatically create subdomains for newly connected branches\. For example, if you connect your **dev** branch, Amplify can automatically create **dev\.exampledomain\.com**\. When you delete a branch, any associated subdomains are automatically deleted\.
**To set up automatic subdomain creation for newly connected branches**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose an app that is connected to a custom domain managed in Route 53\.
1. In the navigation pane, choose **App Settings**, and then choose **Domain management**\.
1. On the **Domain management** page, choose **Edit domain**\.
1. Select the **Sub\-domain auto\-detection** check box on the bottom left side\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.md |
84e98e40a7a7-0 | After you enable **Sub\-domain auto\-detection** using the preceding procedures, your app’s pull request web previews will also be accessible with automatically created subdomains\. When a pull request is closed, the associated branch and subdomain are automatically deleted\. For more information on setting up web previews for pull requests, see [Web previews](pr-previews.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.md |
6f2776106170-0 | **To add a custom domain managed by Google Domains**
1. Follow steps one through six of the procedure [To add a custom domain managed by a third\-party DNS provider](to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md)\.
1. Log in to your account at [https://domains\.google\.com](https://domains.google.com) and choose **DNS** in the left navigation pane\.
1. Scroll down the page to **Custom resource records** where you need to add two new CNAME records\.
1. Create the first CNAME record to point all subdomains to the Amplify domain as follows:
1. For **Name**, enter only the subdomain name\. For example, if your subdomain is **www\.example\.com**, enter **www** for **Name**\.
1. For **Data**, enter the value that's available in the Amplify Console\.
If the Amplify Console displays the domain for your app as **xxxxxxxxxxxxxx\.cloudfront\.net**, enter **xxxxxxxxxxxxx\.cloudfront\.net** for **Data**\.
1. Create the second CNAME record to point to the AWS Certificate Manager \(ACM\) validation server\. A single validated ACM generates an SSL certificate for your domain\.
1. For **Name**, enter the subdomain\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-google-domains.md |
6f2776106170-1 | 1. For **Name**, enter the subdomain\.
For example, if the DNS record in the Amplify Console for verifying ownership of your subdomain is **\_c3e2d7eaf1e656b73f46cd6980fdc0e\.example\.com**, enter only **\_c3e2d7eaf1e656b73f46cd6980fdc0e** for **Name**\.
1. For **Data**, enter the ACM validation certificate\.
For example, if the validation server is **\_68126cb4e8b7ab90c515ea3edb5be60d\.hkvuiqjoua\.acm\-validations\.aws\.**, enter **\_68126cb4e8b7ab90c515ea3edb5be60d\.hkvuiqjoua\.acm\-validations\.aws\.** for **Data**\.
![\[Screenshot of the Custom resource records section on the Google Domains website.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-google-2Update.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-google-domains.md |
6f2776106170-2 | 1. Google Domains doesn’t support ANAME/ALIAS records\. For DNS providers that don't have ANAME/ALIAS support, we strongly recommend migrating your DNS to Amazon Route 53\. For more information, see [Configuring Amazon Route 53 as your DNS service](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html)\. If you want to keep Google Domains as your provider and update the root domain, set up a subdomain forward\. Locate the **Synthetic records** pane\. For **Subdomain**, enter the **@** symbol to specify the root domain\. For **Destination URL**, enter your subdomain to forward to\.
![\[Screenshot of the Synthetic records section on the Google Domains website.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-google-3Update.png)
**Note**
Updates to your DNS settings for a Google domain can take up to 48 hours to take effect\. For help with resolving errors that occur, see [Troubleshooting custom domains](custom-domain-troubleshoot-guide.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-google-domains.md |
18a2de8a62d6-0 | A subdomain is the part of your URL that appears before your domain name\. For example, **www** is the subdomain of **www\.amazon\.com** and **aws** is the subdomain of **aws\.amazon\.com**\. If you already have a production website, you might want to only connect a subdomain\. Subdomains can also be multilevel, for example **beta\.alpha\.example\.com** has the multilevel subdomain **beta\.alpha**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-manage-subdomains.md |
7d51c121b6b5-0 | 1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose your app that you want to add a subdomain to\.
1. In the navigation pane, choose **App Settings**, and then choose **Domain management**\.
1. On the **Domain management** page, choose **Add domain**\.
1. For **Domain**, enter the name of your root domain and then choose **Configure domain**\. For example, if the name of your domain is **https://example\.com**, enter **example\.com** for **Domain**\.
1. Choose **Exclude root** and modify the name of the subdomain\. For example if the domain is **example\.com** you can modify it to only add the subdomain **alpha**\.
![\[Screenshot of the Add domain section in the Amplify Console configured to add a subdomain.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-customdomain-configure-2Update.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-manage-subdomains.md |
7805f2cace84-0 | 1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose your app that you want to add a multilevel subdomain to\.
1. In the navigation pane, choose **App Settings**, and then choose **Domain management**\.
1. On the **Domain management** page, choose **Add domain**\.
1. For **Domain**, enter the name of a domain with a subdomain, choose **Exclude root**, and modify the subdomain to add a new level\.
For example, if you have a domain called **alpha\.example\.com** and you want to create a multilevel subdoman **beta\.alpha\.example\.com**, you would enter **beta** as the subdomain value, as shown in the following screenshot\.
![\[Screenshot of the Add domain section in the Amplify Console configured to add a multilevel subdomain.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-customdomain-configure-3Update.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-manage-subdomains.md |
bcf924cc7330-0 | After adding a custom domain to an app, you can edit an existing subdomain or add a new subdomain\.
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose your app that you want to manage subdomains for\.
1. In the navigation pane, choose **App Settings**, and then choose **Domain management**\.
1. On the **Domain management** page, choose **Manage subdomains**\.
1. In **Edit domain**, you can edit your existing subdomains as needed\.
1. \(Optional\) To add a new subdomain, choose **Add**\.
1. Choose **Update** to save your changes\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-manage-subdomains.md |
971cf75063a9-0 | Use the topics in this section to find detailed reference material for AWS Amplify\.
**Topics**
+ [AWS CloudFormation support](cloudformation-support-chapter.md)
+ [AWS CLI support](aws-cli-support-chapter.md)
+ [Resource tagging support](resource-tagging-support-chapter.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/aws-amplify-reference-chapter.md |
42dc3928e25d-0 | **To add a custom domain managed by GoDaddy**
1. Follow steps one through six of the procedure [Add a custom domain managed by a third\-party DNS provider](to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md)\.
1. Log in to your GoDaddy account\.
1. In your list of domains, find the domain to add and choose **DNS**\. GoDaddy displays a list of records for your domain\. You need to add two new CNAME records\.
1. Create the first CNAME record to point your subdomains to the Amplify domain\.
1. For **Host**, enter only the subdomain\. For example, if your subdomain is **www\.example\.com**, enter **www** for **Host**\.
1. For **Points to**, look at your DNS records in the Amplify Console and then enter the value\. If the Amplify Console displays the domain for your app as **xxxxxxxxxxxxxx\.cloudfront\.net**, enter **xxxxxxxxxxxxxx\.cloudfront\.net** for **Points to**\.
![\[Screenshot of the section for creating a CNAME record on the GoDaddy website.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-godaddy-2Update.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-godaddy.md |
42dc3928e25d-1 | 1. Create the second CNAME record to point to the AWS Certificate Manager \(ACM\) validation server\. A single validated ACM generates an SSL certificate for your domain\.
1. For **Host**, enter the subdomain\.
For example, if the DNS record in the Amplify Console for verifying ownership of your subdomain is **\_c3e2d7eaf1e656b73f46cd6980fdc0e\.example\.com**, enter only **\_c3e2d7eaf1e656b73f46cd6980fdc0e** for **Host**\.
1. For **Points to**, enter the ACM validation certificate\.
For example, if the validation server is **\_cjhwou20vhu2exampleuw20vuyb2ovb9\.j9s73ucn9vy\.acm\-validations\.aws **, enter **\_cjhwou20vhu2exampleuw20vuyb2ovb9\.j9s73ucn9vy\.acm\-validations\.aws** for **Points to**\.
![\[Screenshot of the section for creating a CNAME record on the GoDaddy website.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-godaddy-3.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-godaddy.md |
42dc3928e25d-2 | 1. This step is not required for subdomains\. GoDaddy doesn’t support ANAME/ALIAS records\. For DNS providers that do not have ANAME/ALIAS support, we strongly recommend migrating your DNS to Amazon Route 53\. For more information, see [Configuring Amazon Route 53 as your DNS service](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html)\.
If you want to keep GoDaddy as your provider and update the root domain, add **Forwarding** and set up a domain forward:
1. Scroll down to the bottom of the **DNS Management** page to find the **Forwarding** box\.
1. For **Forward to**, choose **http://**, and then enter the name of your subdomain to foward to \(for example, **www\.example\.com**\)\.
1. For **Forward Type**, choose **Temporary \(302\)**\.
1. For **Settings**, choose **Forward only**\.
![\[Screenshot of the Forwarding pane on GoDaddy website.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-godaddy-4Update.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-godaddy.md |
51c037c92d8e-0 | Web previews offer development and quality assurance \(QA\) teams a way to preview changes from pull requests \(PRs\) before merging code to a production or integration branch\. Pull requests let you tell others about changes you’ve pushed to a branch in a repository\. After a pull request is opened, you can discuss and review the potential changes with collaborators and add follow\-up commits before your changes are merged into the base branch\.
A web preview deploys every pull request made to your GitHub repository to a unique preview URL which is completely different from the URL your main site uses\. For apps with backend environments provisioned using the Amplify CLI, every pull request \(**private Git repositories only**\) spins up an ephemeral backend that is deleted when the PR is closed\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/previews1.png)
**Note**
**Previews** is visible in the Amplify Console’s App settings menu only when an app is set up for continuous deployment and connected to a git repository\. For instructions on this type of deployment, see [Getting started with existing code](getting-started.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pr-previews.md |
846b53726e13-0 | **To enable web previews for pull requests**
1. Choose **App settings**, choose ** Previews** and then choose **Enable previews**\. For GitHub repositories only, you are required to install a GitHub app in your account to enable this feature\. You can give the Amplify Console permission to all repositories or the current repository only\.
**Important**
For security purposes, previews only work with private repositories for fullstack apps using the Amplify CLI\.
1. After you enable previews, return to the Amplify Console to enable previews for specific branches\. Choose a branch from the list and choose **Manage**\. For fullstack applications, you can choose to create a a new backend for every pull request, or point all pull requests to an existing backend environment\. By choosing the first option, you can test changes without impacting production\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/previews2.png)
The next time you submit a pull request for the branch, the Amplify Console builds and deploys your PR to a preview URL\. For GitHub repositories only, you can view a preview of your URL directly from the pull request\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/previews3.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pr-previews.md |
846b53726e13-1 | ![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/previews4.png)
After the pull request is closed, the preview URL is deleted, and any ephemeral backend environment linked to the pull request is deleted\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pr-previews.md |
6f3b3f593078-0 | Web previews from pull requests are accessible with subdomains for an Amplify app that is connected to a custom domain managed by Amazon Route 53\. When the pull request is closed, branches and subdomains associated with the pull request are automatically deleted\. This is the default behavior for web previews after you set up pattern\-based feature branch deployments for your app\. For instructions on setting up automatic subdomains, see [Set up automatic subdomains for a Amazon | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pr-previews.md |
6f3b3f593078-1 | [Set up automatic subdomains for a Amazon Route 53 custom domain](to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/pr-previews.md |
3a16c9965d1b-0 | If you are not using Amazon Route 53 to manage your domain, you can add a custom domain managed by a third\-party DNS provider to your app deployed in the Amplify Console\.
If you are using GoDaddy or Google Domains, see [Add a custom domain managed by GoDaddy](to-add-a-custom-domain-managed-by-godaddy.md) or [Add a custom domain managed by Google Domains](to-add-a-custom-domain-managed-by-google-domains.md) for procedures specific to these providers\.
**To add a custom domain managed by a third\-party DNS provider**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose your app that you want to add a custom domain to\.
1. In the navigation pane, choose **App Settings**, **Domain management**\.
1. On the Domain management page, choose **Add domain**\.
1. For **Domain**, enter the name of your root domain, and then choose **Configure domain**\. For example, if the name of your domain is **https://example\.com**, enter **example\.com**\.
If you don't already own the domain and it is available, you can purchase the domain in [Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-register.html)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md |
3a16c9965d1b-1 | 1. By default, the Amplify Console automatically creates two subdomain entries for your domain\. For example, if your domain name is **example\.com**, you will see the subdomains **https://www\.example\.com** and **https://example\.com** with a redirect set up from the root domain to the **www** subdomain\.
\(Optional\) You can modify the default configuration if you want to add subdomains only\. To change the default configuration, choose **Rewrites and redirects** from the navigation pane, configure your domain, and then choose **Save**\.
![\[Screenshot of the Domain management section in the Amplify Console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-thirdparty-1Update.png)
1. Do one of the following:
+ If you're using GoDaddy, go to [Add a custom domain managed by GoDaddy](to-add-a-custom-domain-managed-by-godaddy.md)\.
+ If you're using Google Domains, go to [Add a custom domain managed by Google Domains](to-add-a-custom-domain-managed-by-google-domains.md)\.
+ If you're using a different third\-party DNS provider, go to the next step in this procedure\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md |
3a16c9965d1b-2 | + If you're using a different third\-party DNS provider, go to the next step in this procedure\.
1. On the **Actions** menu, choose **View DNS records**\. Use the DNS records displayed in the Amplify Console to update your DNS records with your third\-party domain provider\.
![\[Screenshot of the Update DNS records section in the Amplify Console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-thirdpartyDNS-1.png)
1. Go to your DNS provider's website, log in to your account, and locate the DNS management settings for your domain\.
1. Configure a CNAME to point to the AWS validation server\. For example, if the validation server is **\_cjhwou20vhu2exampleuw20vuyb2ovb9\.j9s73ucn9vy\.acm\-validations\.aws**, enter **\_cjhwou20vhu2exampleuw20vuyb2ovb9\.j9s73ucn9vy\.acm\-validations\.aws**\. The Amplify Console uses this information to verify ownership of your domain and generate an SSL certificate for your domain\. Once the Amplify Console validates ownership of your domain, all traffic will be served using HTTPS/2\.
**Important** | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md |
3a16c9965d1b-3 | **Important**
It is important that you perform this step soon after adding your custom domain in the Amplify Console\. The AWS Certificate Manager \(ACM\) immediately starts attempting to verify ownership\. Over time, the checks become less frequent\. If you add or update your CNAME records a few hours after you create your app, this can cause your app to get stuck in the pending verification state\.
1. Configure a second CNAME record \(for example, **https://\*\.example\.com**\), to point your subdomains to the Amplify domain\. If you have production traffic, we recommended you update this CNAME record after your domain status shows as **AVAILABLE** in the Amplify Console\.
1. Configure the ANAME/ALIAS record to point to the root domain of your amplifyapp domain \(for example **https://example\.com**\)\. An ANAME record points the root of your domain to a hostname\. If you have production traffic, we recommended that you update your ANAME record after your domain status shows as **AVAILABLE** in the console\. For DNS providers that don't have ANAME/ALIAS support, we strongly recommend migrating your DNS to Route 53\. For more information, see [Configuring Amazon Route 53 as your DNS service](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring.html)\.
**Note** | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md |
3a16c9965d1b-4 | **Note**
Verification of domain ownership and DNS propagation for third\-party domains can take up to 48 hours\. For help resolving errors that occur, see [Troubleshooting custom domains](custom-domain-troubleshoot-guide.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md |
cbf5113e8df5-0 | **Topics**
+ [Custom Build Images](#setup)
+ [Live Package Updates](#setup-live-updates) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-build-image.md |
7b7677d4226c-0 | Custom Build Images can be used to provide a customized build environment\. If you have specific dependencies that take a long time to install during a build using our default container, you can create your own Docker image and reference it during a build\. Images can be hosted on [Docker Hub](https://hub.docker.com/)\. The format expected here is the same as the format Docker pull command \(e\.g\. *node:latest*\)\.
**Note**
**Build settings** is visible in the Amplify Console’s App settings menu only when an app is set up for continuous deployment and connected to a git repository\. For instructions on this type of deployment, see [Getting started with existing code](getting-started.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-build-image.md |
26c774673785-0 | 1. From your App Detail page, choose **App settings > Build settings**\.
1. From the **Build image settings** container, choose **Edit**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/custom-build-1.png)
1. Specify your custom build image and choose **Save**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/custom-build-2.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-build-image.md |
c7d02e1f51f1-0 | In order for a custom build image to work as an Amplify Console build image there are a few requirements for the image:
1. **cURL**: When we launch your custom image, we download our build runner into your container, and therefore we require cURL to be present\. If this dependency is missing, the build will instantly fail without any output as our build\-runner was unable to produce any output\.
1. **Git**: In order to clone your Git repository we require Git to be installed in the image\. If this dependency is missing, the ‘Cloning repository’ step will fail\.
1. **OpenSSH**: In order to securely clone your repository we require OpenSSH to set up the SSH key temporarily during the build, the OpenSSH package provides the commands that the build runner requires to do this\.
1. **\(NPM\-based builds\)Node\.JS\+NPM**: Our build runner does not install Node, but instead relies on Node and NPM being installed in the image\. This is only required for builds that require NPM packages or Node specific commands\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-build-image.md |
f885a902bcc1-0 | Live Package Updates allows you to specify versions of packages and dependencies to use in our default build image\. Our default build image comes with several packages and dependencies pre\-installed \(e\.g\. Hugo, Amplify CLI, Yarn, etc\)\. Live Package Updates allows you to override the version of these dependencies and specify either a specific version, or always ensure the latest version is installed\. If Live Package Updates is enabled, before your build is executed, the | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-build-image.md |
f885a902bcc1-1 | is enabled, before your build is executed, the build runner will first update \(or downgrade\) the specified dependencies\. This will increase the build time proportional to the time it takes to update the dependencies, but the benefit is that you can ensure the same version of a dependency is used to build your app\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-build-image.md |
e9b008a4b813-0 | 1. From your App Detail page, choose **App Settings > Build Settings**\.
1. From the **Build image settings** section, choose **Edit**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/custom-build-1.png)
1. Select a package you’d like to change from the **Add package version override** list\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/live-updates-1.png)
1. Input either a specific version of this dependency, or keep the default \(**latest**\)\. If **latest** is used, the dependency will always be upgraded to the latest version available\. Choose **Save** to apply the settings\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/live-updates-2.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-build-image.md |
01cf31ead7a7-0 | In this walkthrough, you learn how to continuously build, deploy, and host a modern web app\. Modern web apps include Single Page App \(SPA\) frameworks \(for example, React, Angular, or Vue\) and static\-site generators \(SSGs\) \(for example, Hugo, Jekyll, or Gatsby\)\.
To get started, log in to the [Amplify Console](https://console.aws.amazon.com/amplify/home) and choose **Get Started** under **Deploy**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-gettingstarted-1.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/getting-started.md |
113bb674391a-0 | Connect your GitHub, Bitbucket, GitLab, or AWS CodeCommit repositories\. You also have the option of manually uploading your build artifacts without connecting a Git repository \(see [Manual Deploys](manual-deploys.md)\)\. After you authorize the Amplify Console, Amplify fetches an access token from the repository provider, but it *doesn’t store the token* on the AWS servers\. Amplify accesses your repository using deploy keys installed in a specific repository only\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-gettingstarted-2.png)
After you connect the repository service provider, choose a repository, and then choose a corresponding branch to build and deploy\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-gettingstarted-3.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/getting-started.md |
53981a670f48-0 | For the selected branch, Amplify inspects your repository to automatically detect the sequence of build commands to be executed\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-gettingstarted-4.png)
**Important:** Verify that the build commands and build output directory \(that is, artifacts > baseDirectory\) is accurate\. If you need to modify this information, choose **Edit** to open the YML editor\. You can save your build settings on our servers, or you can download the YML and add it to the root of your repo \(for monorepos, store the YML at the app’s root directory\)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-gettingstarted-5.png)
For more information, see [YML structure](build-settings.md#yml-specification-syntax)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/getting-started.md |
33a44a5b39b1-0 | If you connected a repository provisioned by the Amplify CLI v1\.0\+ \(run *amplify \-v* to find CLI version\), the Amplify Console will deploy or automatically update backend resources \(any resource provisioned by the Amplify CLI\) in a single workflow with the frontend build\. You can choose to point an existing backend environment to your branch, or create a completely new environment\. For a step\-by\-step tutorial, see [Deploying a fullstack app](deploy-backend.md)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/reuse-backend.png)
To deploy backend functionality using the Amplify CLI during your build, create or reuse an IAM service role\. IAM roles are a secure way to grant the Amplify Console permissions to act on resources in your account\.
**Note:** The Amplify CLI won’t run without an IAM service role enabled\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-gettingstarted-7.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/getting-started.md |
d31333c8796b-0 | Almost every app needs to get configuration information at runtime\. These configurations can be database connection details, API keys, or different parameters\. Environment variables provide a means to expose these configurations at build time\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/getting-started.md |
9baba4b4f7c5-0 | Review all of your settings to ensure everything is set up correctly\. Choose **Save and deploy** to deploy your web app to a global content delivery network \(CDN\)\. Your front end build typically takes 1 to 2 minutes but can vary based on size of the app\.
Access the build logs screen by selecting a progress indicator on the branch tile\. A build has the following stages:
1. **Provision** \- Your build environment is set up using a Docker image on a host with 4 vCPU, 7GB memory\. Each build gets its own host instance, ensuring that all resources are securely isolated\. The contents of the Docker file are displayed to ensure that the default image supports your requirements\.
1. **Build** \- The build phase consists of three stages: setup \(clones repository into container\), deploy backend \(runs the Amplify CLI to deploy backend resources\), and build front end \(builds your front\-end artifacts\)\.
1. **Deploy** \- When the build is complete, all artifacts are deployed to a hosting environment managed by Amplify\. Every deployment is atomic \- atomic deployments eliminate maintenance windows by ensuring that the web app is only updated after the entire deployment has completed\.
1. **Verify** \- To verify that your app works correctly, Amplify renders screen shots of the index\.html in multiple device resolutions using Headless Chrome\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-backend-frontend.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/getting-started.md |
cbe049be4a12-0 | + [Add a custom domain to your app](custom-domains.md)
+ [Manage multiple environments](multi-environments.md)
+ [Preview pull requests before merging](pr-previews.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/getting-started.md |
b43b62c33737-0 | You can connect a custom domain to an app that you’ve deployed in the Amplify Console\. You can purchase a custom domain through a domain registrar such as Amazon Route 53, GoDaddy, or Google Domains\. Route 53 is Amazon’s Domain Name System \(DNS\) web service\. For more information about using Route 53, see [What is Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html)\.
When you deploy your web app with the Amplify Console, it is hosted at:
```
https://branch-name.d1m7bkiki6tdw1.amplifyapp.com
```
When you connect a custom domain, users see that your app is hosted on a custom URL, such as the following:
```
https://www.example.com
```
The Amplify Console issues an SSL certificate for all domains connected to your app so that all traffic is secured through HTTPS/2\. The SSL certificate generated by AWS Certificate Manager \(ACM\) is valid for 13 months and renews automatically as long as your app is hosted with AWS Amplify\.
Prior to connecting an app to a custom domain, the app must be deployed in AWS Amplify\. For more information about completing this step, see [Getting started with existing code](getting-started.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domains.md |
b43b62c33737-1 | Connecting to a custom domain requires a basic knowledge of domains and DNS terminology\. For more information about domains and DNS, see [Understanding DNS terminology and concepts](understanding-dns-terminology-and-concepts.md)\.
**Topics**
+ [Understanding DNS terminology and concepts](understanding-dns-terminology-and-concepts.md)
+ [Add a custom domain managed by Amazon Route 53](to-add-a-custom-domain-managed-by-amazon-route-53.md)
+ [Add a custom domain managed by a third\-party DNS provider](to-add-a-custom-domain-managed-by-a-third-party-dns-provider.md)
+ [Add a custom domain managed by GoDaddy](to-add-a-custom-domain-managed-by-godaddy.md)
+ [Add a custom domain managed by Google Domains](to-add-a-custom-domain-managed-by-google-domains.md)
+ [Manage subdomains](to-manage-subdomains.md)
+ [Set up automatic subdomains for a Amazon Route 53 custom domain](to-set-up-automatic-subdomains-for-a-Route-53-custom-domain.md)
+ [Troubleshooting custom domains](custom-domain-troubleshoot-guide.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-domains.md |
c649db4a3f6d-0 | The AWS Amplify Console provides a Git\-based workflow for hosting fullstack serverless web apps with continuous deployment\. A fullstack serverless app consists of a backend built with cloud resources such as GraphQL or REST APIs, file and data storage, and a frontend built with single\-page application \(SPA\) frameworks such as React, Angular, Vue, or Gatsby\.
AWS Amplify Console supports common SPA frameworks \(e\.g\. React, Angular, Vue\.js, Ionic, Ember\), as well as static\-site generators like Gatsby, Eleventy, Hugo, VuePress, and Jekyll\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/welcome.md |
1ca1ffae5fad-0 | To get started with Amplify Console [connect your repository](getting-started.md) \(GitHub, BitBucket Cloud, GitLab, and AWS CodeCommit\) to set up continuous deployment\. Alternatively, start with one of our [fullstack samples](deploy-backend.md)\. Amplify Console automatically detects the frontend build settings along with any backend functionality provisioned with the Amplify CLI \(command\-line toolchain for creating serverless backends\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/welcome.md |
31b321b9f13f-0 | With the Amplify Console, you can do the following:
+ Manage production and staging environments for your frontend and backend by connecting new branches\. [See feature branch deployments](multi-environments.md)\.
+ Connect your custom domain\. If you manage your domain in Amazon Route 53, the Amplify Console automatically connects the root domain \(yourdomain\.com\), www subdomains \(www\.yourdomain\.com\), and branch subdomains \(https://dev\.yourdomain\.com\)\. [See custom domains](custom-domains.md)\.
+ Preview changes during code reviews by setting up [Pull\-Request Previews](pr-previews.md)\.
+ Improve your app quality with end to end tests\. [See End\-to\-End Testing](running-tests.md)\.
+ Password protect your web app so you can work on new features without making them publicly accessible\. [See restricting access](access-control.md)\.
+ Set up rewrites and redirects to maintain SEO rankings and route traffic based on your client app requirements\. [See redirects](redirects.md)\.
Also:
+ Instant cache invalidations ensure your app is updated on every code commit instantly\.
+ Atomic deployments eliminate maintenance windows by ensuring that the web app is only updated when the entire deployment has finished\. This eliminates scenarios where files fail to upload properly\.
+ Get screen shots of your app rendered on different mobile devices to pinpoint layout issues\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/welcome.md |
29a7230f056e-0 | Modern web applications are constructed as single\-page applications \(SPA\) that package all application components into static files\. Traditional client\-server web architectures led to poor experiences; every button click or search required a round trip to the server, re\-rendering the entire application\. Modern web apps offer a native app\-like user experience by serving the app frontend, or user interface, efficiently to browsers as prebuilt HTML/JavaScript files that can then invoke backend functionality without reloading the page\.
Modern web applications functionality is often spread across multiple places, such as databases, authentication services, frontend code running in the browser, and backend business logic, or AWS Lambda functions, running in the cloud\. This makes application deployments complex and time\-consuming as developers need to carefully coordinate deployments across the frontend and backend to avoid partial or failed deployments\. The AWS Amplify Console simplifies deployment of the frontend and backend in a single workflow\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/welcome.md |
3e3288545d0e-0 | The **Deploy to Amplify Console** button enables you to share GitHub projects publicly or within your team\. The button looks like:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/button.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/one-click.md |
1a1864188be6-0 | Add this button to your GitHub README\.md file, blog post, or any other markup page that renders HTML\. The button has two components:
1. An SVG image: `https://oneclick.amplifyapp.com/button.svg`
1. The Amplify Console URL with a link to your GitHub repository\. Please copy your repo URL \(e\.g\. `https://github.com/username/repository`\) only or provide a deep link into a specific folder \(e\.g\. `https://github.com/username/repository/tree/branchname/folder`\)\. The Amplify Console will deploy the default branch in your repository\. Additional branches can be connected after the app is connected\.
1. Add the button to a markdown file \(e\.g\. your GitHub README\.md\)\. **Please replace https://github\.com/username/repository with your repository name**\.
```
[](https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/username/repository)
```
1. You can also add the button to any HTML document:
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/one-click.md |
1a1864188be6-1 | ```
1. You can also add the button to any HTML document:
```
<a href="https://console.aws.amazon.com/amplify/home#/deploy?repo=https://github.com/username/repository">
<img src="https://oneclick.amplifyapp.com/button.svg" alt="Deploy to Amplify Console">
</a>
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/one-click.md |
318c81fb9a3d-0 | Custom HTTP headers allow you to specify headers for every HTTP response\. Response headers can be used for debugging, security, and informational purposes\. Define custom header rules for your app as follows:
1. From the navigation bar on the left, choose App Settings > Build Settings, and then choose *Edit* to edit your buildspec\.
1. In the *frontend* section of the YML file, add the custom headers for your app as follows:
```
version: 0.1
frontend:
phases:
build:
post_build:
artifacts:
baseDirectory:
customHeaders:
- pattern: '*.json'
headers:
- key: 'custom-header-name-1'
value: 'custom-header-value-1'
- key: 'custom-header-name-2'
value: 'custom-header-value-2'
- pattern: '/path/*'
headers:
- key: 'custom-header-name-1'
value: 'custom-header-value-2'
```
+ **pattern** \- Headers applied to all URL file paths that match the pattern\.
+ **headers** \- Define headers that match the file pattern\. The **key** is the custom header name and the **value** is the custom header value\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-headers.md |
318c81fb9a3d-1 | + To learn more about HTTP headers, please see Mozilla’s [documentation for a list of HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers)\.
1. Choose **Save**\. Your custom header settings will now be applied to your app\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-headers.md |
5f107395cdc7-0 | The following security headers enable enforcing HTTPS, preventing XSS attacks, and defending your browser against clickjacking\. Add it to your app’s buildspec and choose **Save** to apply the custom header settings\.
```
customHeaders:
- pattern: '**/*'
headers:
- key: 'Strict-Transport-Security'
value: 'max-age=31536000; includeSubDomains'
- key: 'X-Frame-Options'
value: 'SAMEORIGIN'
- key: 'X-XSS-Protection'
value: '1; mode=block'
- key: 'X-Content-Type-Options'
value: 'nosniff'
- key: 'Content-Security-Policy'
value: 'default-src self'
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/custom-headers.md |
4f381a99f07d-0 | The Amplify Console requires permissions to deploy backend resources with your front end\. You use a service role to accomplish this\. A service role is the IAM role that Amplify Console assumes when calling other services on your behalf\. In this guide, you will create an Amplify service role that has full access to the account which is required to deploy any Amplify CLI resources\. [Learn more](https://aws-amplify.github.io/docs/cli/concept)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/how-to-service-role-amplify-console.md |
2070fa91d60e-0 | [Open the IAM Console](https://console.aws.amazon.com/iam/home?#/roles) and choose **Roles** from the left navigation bar, then choose **Create role**\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/how-to-service-role-amplify-console.md |
4d786842c65e-0 | In the role selection screen find **Amplify** and choose the **Amplify\-Backend Deployment** role\. Accept all the defaults and choose a name for your role \(e\.g\. AmplifyConsoleServiceRole\-AmplifyRole\)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/servicerole.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/how-to-service-role-amplify-console.md |
446be64f47f0-0 | Open the [Amplify Console](https://console.aws.amazon.com/amplify/)\. If you are in the process of deploying a new app, choose **refresh**, and then choose the role you just created\. It should look like **AmplifyConsoleServiceRole\-AmplifyRole**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-servicerole.png)
If you already have an existing app, you can find the service role setting in **App settings > General** and then choose **Edit** from the top right corner of the box\. Pick the service role you just created from the dropdown and choose **Save**\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-servicerole2.png)
The Amplify Console now has permissions to deploy backend resources\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/how-to-service-role-amplify-console.md |
915504226067-0 | You now run end\-to\-end \(E2E\) tests in the test phase of your Amplify app to catch regressions before pushing code to production\. The test phase can be configured in the build specification YML and can be used to run any testing framework of your choice during a build\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/cypress.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/running-tests.md |
bf8cc5591fbe-0 | Cypress is a JavaScript\-based framework that allows you to run E2E tests on a browser\. [This tutorial](http://aws.amazon.com/blogs/mobile/run-end-to-end-cypress-tests-for-your-fullstack-ci-cd-deployment-with-amplify-console/) will demonstrate how to set up E2E tests from scratch\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/running-tests.md |
f9a04913e307-0 | You can use the test step to run any test commands at build time\. For E2E tests, the Amplify Console offers a deeper integration with Cypress that allows you to generate a UI report for your tests\. To add Cypress tests to an existing app, update your amplify\.yml build settings with the following values\.
```
test:
phases:
preTest:
commands:
- npm ci
- npm install wait-on
- npm install [email protected] mochawesome mochawesome-merge mochawesome-report-generator
- 'npm start & npx wait-on http://localhost:8080'
test:
commands:
- 'npx cypress run --reporter mochawesome --reporter-options "reportDir=cypress/report/mochawesome-report,overwrite=false,html=false,json=true,timestamp=mmddyyyy_HHMMss"'
postTest:
commands:
- npx mochawesome-merge cypress/report/mochawesome-report/mochawesome*.json > cypress/report/mochawesome.json
artifacts:
baseDirectory: cypress
configFilePath: '**/mochawesome.json'
files:
- '**/*.png'
- '**/*.mp4' | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/running-tests.md |
f9a04913e307-1 | files:
- '**/*.png'
- '**/*.mp4'
```
+ **preTest** \- Install all the dependencies required to run Cypress tests\. Amplify Console uses [mochaawesome](https://github.com/adamgruber/mochawesome) to generate a report to view your test results and [wait\-on](https://github.com/jeffbski/wait-on) to set up the localhost server during the build\.
+ **test** \- Run cypress commands to execute tests using mochawesome\.
+ **postTest** \- The mochawesome report is generated from the output JSON\.
+ **artifacts>baseDirectory** \- The directory from which tests are run\.
+ **artifacts>configFilePath** \- The generated test report data\.
+ **artifacts>files** \- The generated artifacts \(screenshots and videos\) available for download\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/running-tests.md |
4fa374414f68-0 | Once the “test” config has been added to your amplify\.yml build settings, the test step will be executed for every build, on every branch\. If you would like to globally disable tests from running, or you would only like tests to run for specific branches, you can use the “USER\_DISABLE\_TESTS” environment variable to do so without modifying your build settings\.
To **globally** disable tests for all branches, add the USER\_DISABLE\_TESTS environment variable with a value of true for all branches, as shown below:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/disable-test-global.png)
To disable tests for a **specific branch**, add the USER\_DISABLE\_TESTS environment variable with a value of false for all branches, and then add an override for each branch you would like to disable with a value of true\. In the following example, tests are disabled on the “main” branch, and enabled for every other branch:
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/disable-test-branch.png)
Disabling tests with this variable will cause the test step to be skipped altogether during a build\. To re\-enable tests, set this value to *false*, or delete the environment variable\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/running-tests.md |
a7bba1362751-0 | Access logs store information about all requests that are made to your Amplify hosted app\. All sites hosted on Amplify Console have logs retrievable for any two week window\. To view access logs choose **App settings > Access logs** from your app’s left navigation bar\. Choose **Edit time range** to choose the two week interval you wish to access\. The logs are available to download in a CSV format\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/access-logs.md |
061d67924713-0 | To analyze access logs you can store the CSV files in an Amazon S3 bucket\. One way to analyze your access logs is to use Amazon Athena\. Athena is an interactive query service that can help you analyze data for AWS services\. You can follow the [step\-by\-step instructions here](https://docs.aws.amazon.com/athena/latest/ug/cloudfront-logs.html#create-cloudfront-table) to create a table\. Once your table has been created, you can query data as follows\.
```
SELECT SUM(bytes) AS total_bytes
FROM logs
WHERE "date" BETWEEN DATE '2018-06-09' AND DATE '2018-06-11'
LIMIT 100;
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/access-logs.md |
b6a563e76dc3-0 | You can set up notifications for an Amplify app to alert stakeholders or team members when a build succeeds or fails\. Amplify Console creates an Amazon Simple Notification Service \(SNS\) topic in your account and uses it to configure email notifications\. This SNS topic can be used to send notifications to other tools such as Slack\. Notifications can be configured to apply to all branches or specific branches of an Amplify app\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/notifications.md |
00e6772cff60-0 | Use the following procedures to set up email notifications for all branches or specific branches of an Amplify app\.
**To set up email notifications for an Amplify app**
1. Sign in to the AWS Management Console and open the [Amplify Console](https://console.aws.amazon.com/amplify/)\.
1. Choose the app that you want to set up email notifications for\.
1. In the navigation pane, choose **App Settings**, **Notifications**, and then in the **Email notifications** section, choose **Add notification**\.
1. Do one of the following in the **Manage notifications** section:
+ To send notifications for a single branch, for **Email**, enter the email address to send notifications to\. For **Branch**, select the name of the branch to send notifications for\.
+ To send notifications for all connected branches, for **Email**, enter the email address to send notifications to\. For **Branch**, select *All Branches*\.
1. Choose **Save** when you are finished\.
![\[Screenshot of the Manage notifications section in the Amplify console.\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-notifications-email.png) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/notifications.md |
f008c19479fa-0 | The Amplify Console enables developers building apps with the Amplify Framework to continuously deploy updates to their backend and frontend on every code commit\. With the Amplify Console you can deploy serverless backends with GraphQL/REST APIs, authentication, analytics, and storage created by the Amplify CLI on the same commit as your frontend code\.
**Important**
This feature only works with the Amplify CLI v4\.0\+
In this tutorial, we are going to create and deploy a React app which implements a basic authentication flow for signing up/signing in users as well as protected client side routing using AWS Amplify\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/deploy-backend.md |
71ce8772792d-0 | Log in to the [Amplify Console](https://console.aws.amazon.com/amplify/home) and choose **Get Started** under **Deploy**\. In the following screen, choose **From fullstack samples**\. Alternatively, start your own adventure by building a backend **from scratch** by installing the Amplify CLI\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/fullstack1.png)
Choose the **Authentication Starter** and **Deploy app**\. You will be asked to connect your GitHub account\. Connecting your GitHub acccount allows the Amplify Console to create a fork of the repository in your account, deploy the AWS backend services, and build and deploy the frontend\. In order to deploy backend resources to AWS, you will need to [create a service role](how-to-service-role-amplify-console.md)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/fullstack2.gif) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/deploy-backend.md |
b61dfdb1e0ae-0 | Your app build will start by deploying the backend followed by the frontend\. Click on the branch name to see the running build\. When the build completes you will be able to see screenshots of your app on different devices\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/amplify-backend-frontend.png)
At the end of the build, you will have one frontend environment \(the main branch deployed at *‘https://main\.appid\.amplifyapp\.com’*\) and one backend environment named devX\. To add a user to your app, you can either register a user through the deployed frontend, or choose the **Authentication** tab which links to the Amazon Cognito UserPool\. Create a user and try logging in to your app\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/fullstack3.gif) | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/deploy-backend.md |
141c3239a862-0 | 1. Let’s add a GraphQL API backend with a NoSQL database to your app\. To start, clone the repository that was forked in your account\.
```
git clone [email protected]:<username>/create-react-app-auth-amplify.git
cd create-react-app-auth-amplify
```
1. From the **Backend environments** tab, choose **Edit backend**\. As a pre\-requisite, follow the instructions to install and configure the Amplify CLI\. The Amplify command line toolchain allows you to edit the backend you just created to add more functionality such as GraphQL/REST APIs, analytics, and storage\. Once the Amplify CLI is configured, copy the *amplify pull* command to connect to this backend from your local machine\.
```
amplify pull --appId XXXXXXXX --envName devw
```
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/fullstack4.png)
1. Add the GraphQL API using the default todo example\. Learn more about modeling your backend with the [GraphQL transform](https://aws-amplify.github.io/docs/cli-toolchain/graphql)\.
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/deploy-backend.md |
141c3239a862-1 | ```
amplify add api
? Please select from one of the below mentioned services GraphQL
? Provide API name: todo
? Choose the default authorization type for the API API key
? Enter a description for the API key:
? After how many days from now the API key should expire (1-365): 7
? Do you want to configure advanced settings for the GraphQL API No, I am done.
? Do you have an annotated GraphQL schema? No
? Do you want a guided schema creation? (Y/n) Y
? What best describes your project: Single object with fields (e.g., “Todo” with ID, name, description)
? Do you want to edit the schema now? No
...
GraphQL schema compiled successfully.
```
1. To deploy these changes to the cloud run the following commands\.
```
amplify push
Current Environment: devw
| Category | Resource name | Operation | Provider plugin |
| -------- | --------------- | --------- | ----------------- |
| Api | todo | Create | awscloudformation |
| Auth | cognitocf0c6096 | No Change | awscloudformation | | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/deploy-backend.md |
141c3239a862-2 | | Auth | cognitocf0c6096 | No Change | awscloudformation |
? Are you sure you want to continue? (Y/n) Y
..
✔ Generated GraphQL operations successfully and saved at src/graphql
✔ All resources are updated in the cloud
GraphQL endpoint: https://gumwpbojgraj5b547y5d3shurq.appsync-api.us-west-2.amazonaws.com/graphql
GraphQL API KEY: da2-vlthvw5qcffxzl2hibgowv3rdq
```
1. Visit the Amplify Console to view the added API category\. Choosing the API category will allow you to navigate to the AppSync Console \(to write queries or mutations performing CRUD operations\), or the DynamoDB Console \(to view your Todo table\)\.
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amplify/latest/userguide/images/fullstack5.png)
1. Use the [Amplify GraphQL client](https://aws-amplify.github.io/docs/js/api#amplify-graphql-client) to write frontend code that lists and updates the todos\. To deploy the updates to your frontend, simply commit your code and a new build will be triggered in the Amplify Console\. | https://github.com/siagholami/aws-documentation/tree/main/documents/aws-amplify-console-user-guide/doc_source/deploy-backend.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.