Skip to content

Commit

Permalink
Move SOS metadata and templates to GitHub, set up an action to valida…
Browse files Browse the repository at this point in the history 
…te. (awsdocs#2011)
  • Loading branch information
@Laren-AWS
Laren-AWS authored Aug 24, 2021
1 parent d79c690 commit 3a68641
Show file tree
Hide file tree
Showing 25 changed files with 2,221 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .doc_gen/cross-content/cross_ApiGatewayDataTracker_Python_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use &AWS; Chalice with the &Python3long; to
create a serverless REST API that uses &ABPlong;, &LAMlong;, and
&DDBlong;. The REST API simulates a system that tracks daily cases
of COVID-19 in the United States, using fictional data. Learn how to:
</para>
<itemizedlist>
<listitem><para>Use &AWS; Chalice to define routes in &LAM; functions that
are called to handle REST requests that come through &ABP;.</para></listitem>
<listitem><para>Use &LAM; functions to retrieve and store data in a &DDB;
table to serve REST requests.</para></listitem>
<listitem><para>Define table structure and security role resources in an &CFNlong; template.</para></listitem>
<listitem><para>Use &AWS; Chalice and &CFNshort; to package and deploy all necessary resources.</para></listitem>
<listitem><para>Use &CFNshort; to clean up all created resources.</para></listitem>
</itemizedlist>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/python/cross_service/apigateway_covid-19_tracker">GitHub</ulink>.
</para>
</block>
23 changes: 23 additions & 0 deletions .doc_gen/cross-content/cross_ApiGatewayWebsocketChat_Python_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use the &Python3long; with &ABPlong; V2 to
create a websocket API that integrates with &LAMlong; and &DDBlong;.
</para>

<itemizedlist>
<listitem><para>Create a websocket API served by &ABP;.</para></listitem>
<listitem><para>Define a &LAM; handler that stores connections in &DDB; and posts messages to
other chat participants.</para></listitem>
<listitem><para>Connect to the websocket chat application and send messages with the Websockets
package.</para></listitem>
</itemizedlist>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/python/cross_service/apigateway_websocket_chat">GitHub</ulink>.
</para>
</block>
25 changes: 25 additions & 0 deletions .doc_gen/cross-content/cross_AuroraRestLendingLibrary_Python_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use the &Python3long; with the &RDSlong; (&RDS;) API and &AWS; Chalice to create a REST API
backed by an &AURlong; database. The web service is fully serverless and represents
a simple lending library where patrons can borrow and return books. Learn how to:
</para>

<itemizedlist>
<listitem><para>Create and manage a serverless &AUR; database cluster.</para></listitem>
<listitem><para>Use &ASMlong; to manage database credentials.</para></listitem>
<listitem><para>Implement a data storage layer that uses &RDS; to move data into
and out of the database.</para></listitem>
<listitem><para>Use &AWS; Chalice to deploy a serverless REST API to &ABPlong; and &LAMlong;.</para></listitem>
<listitem><para>Use the Requests package to send requests to the web service.</para></listitem>
</itemizedlist>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/python/cross_service/aurora_rest_lending_library">GitHub</ulink>.
</para>
</block>
15 changes: 15 additions & 0 deletions .doc_gen/cross-content/cross_DynamoDBDataTracker_Java_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use the &DDBlong; API to
create a dynamic web application that tracks work data.
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javav2/usecases/creating_dynamodb_web_app">GitHub</ulink>.
</para>
</block>
20 changes: 20 additions & 0 deletions .doc_gen/cross-content/cross_LambdaAPIGateway_JavaScript_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to create an &LAMlong; function by using the &LAM; JavaScript runtime API.
This example invokes different &AWS; services to perform a specific use case. This example demonstrates how to
create a &LAM; function invoked by &ABPlong; that scans an &DDBlong; table for work anniversaries
and uses &SNSlong; (&SNS;) to send a text message to your employees that congratulates
them at their one year anniversary date.
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascriptv3/example_code/cross-services/lambda-api-gateway">GitHub</ulink>.
</para>
<para>This example is also available in the
<ulink type="documentation" url="sdk-for-javascript/v3/developer-guide/api-gateway-invoking-lambda-example.html">&JSBlong; v3 developer guide</ulink>.</para>
</block>
21 changes: 21 additions & 0 deletions .doc_gen/cross-content/cross_LambdaScheduledEvents_JavaScript_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to create an &EVlong; scheduled event that invokes an &LAMlong; function.
Configure &EV; to use a cron expression to schedule when the &LAM; function is invoked.
In this example, you create a &LAM; function by using the &LAM; JavaScript runtime API.
This example invokes different &AWS; services to perform a specific use case. This example demonstrates how to
create an app that sends a mobile text message to your employees that congratulates
them at the one year anniversary date.
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascriptv3/example_code/cross-services/lambda-scheduled-events">GitHub</ulink>.
</para>
<para>This example is also available in the
<ulink type="documentation" url="sdk-for-javascript/v3/developer-guide/scheduled-events-invoking-lambda-example.html">&JSBlong; v3 developer guide</ulink>.</para>
</block>
21 changes: 21 additions & 0 deletions .doc_gen/cross-content/cross_ServerlessWorkflows_JavaScript_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to create an &AWS; serverless workflow by using &SFNlong; and the &JSBlong;.
Each workflow step is implemented using an &LAMlong; function.
</para>
<para>&LAM; is a compute service that enables you to run code without provisioning or managing servers.
&SFN; is a serverless orchestration service that lets you combine &LAM; functions and other &AWS;
services to build business-critical applications.
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascriptv3/example_code/cross-services/lambda-step-functions">GitHub</ulink>.
</para>
<para>This example is also available in the
<ulink type="documentation" url="sdk-for-javascript/v3/developer-guide/serverless-step-functions-example.html">&JSBlong; v3 developer guide</ulink>.</para>
</block>
23 changes: 23 additions & 0 deletions .doc_gen/cross-content/cross_StepFunctionsMessenger_Python_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use the &Python3long; with &SFNlong; to create a messenger application that
retrieves message records from an &DDBlong; table and sends them with &SQSlong; (&SQS;).
The state machine integrates with an &LAMlong; function to scan the database for unsent messages.
</para>

<itemizedlist>
<listitem><para>Create a state machine that retrieves and updates message records from an &DDBlong; table.</para></listitem>
<listitem><para>Update the state machine definition to also send messages to &SQSlong; (&SQS;).</para></listitem>
<listitem><para>Start and stop state machine runs.</para></listitem>
<listitem><para>Connect to &LAM;, &DDB;, and &SQS; from a state machine by using service integrations.</para></listitem>
</itemizedlist>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/python/cross_service/stepfunctions_messenger">GitHub</ulink>.
</para>
</block>
17 changes: 17 additions & 0 deletions .doc_gen/cross-content/cross_SubmitDataApp_JavaScript_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
This example shows how to build an app that enables users to submit data to an &DDBlong; table,
and send a text message to the administrator using &SNSlong; (&SNS;).
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascriptv3/example_code/cross-services/submit-data-app">GitHub</ulink>.
</para>
<para>This example is also available in the
<ulink type="documentation" url="sdk-for-javascript/v3/developer-guide/cross-service-example-submitting-data.html">&JSBlong; v3 developer guide</ulink>.</para>
</block>
18 changes: 18 additions & 0 deletions .doc_gen/cross-content/cross_TextractExplorer_JavaScript_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use the &JSBlong; to build a React application
that uses &TEXTRACTlong; to extract data from a document image and display it in
an interactive web page. This example runs in a web browser and requires an
authenticated &COGlong; identity for credentials. It uses &S3long; (&S3;) for storage, and for notifications
it polls an &SQSlong; (&SQS;) queue that is subscribed to an &SNSlong; (&SNS;) topic.
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascriptv3/example_code/cross-services/textract-react">GitHub</ulink>.
</para>
</block>
23 changes: 23 additions & 0 deletions .doc_gen/cross-content/cross_TextractExplorer_Python_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use the &Python3long; with &TEXTRACTlong; to detect text,
form, and table elements in a document image. The input image and &TEXTRACT; output are
shown in a Tkinter application that lets you explore the detected elements.
</para>
<itemizedlist>
<listitem><para>Submit a document image to &TEXTRACT; and explore the output of detected elements.</para></listitem>
<listitem><para>Submit images directly to &TEXTRACT; or through an &S3long; (&S3;) bucket.</para></listitem>
<listitem><para>Use asynchronous APIs to start a job that publishes a notification to an &SNSlong; (&SNS;) topic when the
job completes.</para></listitem>
<listitem><para>Poll an &SQSlong; (&SQS;) queue for a job completion message and display the results.</para></listitem>
</itemizedlist>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/python/cross_service/textract_explorer">GitHub</ulink>.
</para>
</block>
19 changes: 19 additions & 0 deletions .doc_gen/cross-content/cross_TranscriptionApp_JavaScript_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Create an app that uses &TSClong; to transcribe and display voice recordings in the browser. The app uses
two &S3long; (&S3;) buckets, one to host the application code, and another to store transcriptions. The app uses
an &COGlong; user pool to authenticate your users. Authenticated users have &IAMlong; (&IAM;) permissions to
access the required &AWS; services.
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascriptv3/example_code/cross-services/transcription-app">GitHub</ulink>.
</para>
<para>This example is also available in the
<ulink type="documentation" url="sdk-for-javascript/v3/developer-guide/transcribe-app.html">&JSBlong; v3 developer guide</ulink>.</para>
</block>
15 changes: 15 additions & 0 deletions .doc_gen/cross-content/cross_TranscriptionStreamingApp_JavaScript_block.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file://zonbook/docbookx.dtd"[
<!ENTITY % phrases-shared SYSTEM "file://AWSShared/common/phrases-shared.ent">
%phrases-shared;
]>
<block>
<para>
Shows how to use &TSClong; to build an app that records, transcribes, and translates live audio in real-time,
and emails the results using &SESlong; (&SES;).
</para>
<para>
For complete source code and instructions on how to set up and run, see the full example on
<ulink url="https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/javascriptv3/example_code/cross-services/transcribe-streaming-app">GitHub</ulink>.
</para>
</block>
Loading

0 comments on commit 3a68641

Please sign in to comment.