Skip to content

Commit 15bccf7

Browse files
mwunderlmwunderl
committed
Metadata for tutorials using services not yet in services.yaml
These 10 metadata files require services to be added to the upstream aws-doc-sdk-examples-tools services.yaml before they can be merged. A local .doc_gen/config/services.yaml is included for preview builds.
1 parent 49f07d9 commit 15bccf7

11 files changed

Lines changed: 294 additions & 0 deletions

‎.doc_gen/config/services.yaml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
account:
2+
long: "&AWS; Account Management"
3+
short: Account
4+
sort: Account Management
5+
version: "2021-02-01"
6+
chime-sdk-voice:
7+
long: "Amazon Chime SDK Voice"
8+
short: Chime SDK Voice
9+
sort: Chime SDK Voice
10+
version: "2022-08-03"
11+
datazone:
12+
long: "Amazon DataZone"
13+
short: DataZone
14+
sort: DataZone
15+
version: "2018-05-10"
16+
dms:
17+
long: "&AWS; Database Migration Service"
18+
short: DMS
19+
sort: Database Migration Service
20+
version: "2016-01-01"
21+
kinesisvideo:
22+
long: "Amazon Kinesis Video Streams"
23+
short: Kinesis Video
24+
sort: Kinesis Video Streams
25+
version: "2017-09-30"
26+
mq:
27+
long: "Amazon MQ"
28+
short: Amazon MQ
29+
sort: MQ
30+
version: "2017-11-27"
31+
network-firewall:
32+
long: "&AWS; Network Firewall"
33+
short: Network Firewall
34+
sort: Network Firewall
35+
version: "2020-11-12"
36+
pinpoint-sms-voice-v2:
37+
long: "&AWS; End User Messaging"
38+
short: End User Messaging
39+
sort: End User Messaging
40+
version: "2022-03-31"
41+
qbusiness:
42+
long: "Amazon Q Business"
43+
short: Q Business
44+
sort: Q Business
45+
version: "2023-11-27"
46+
sso-admin:
47+
long: "&AWS; IAM Identity Center"
48+
short: IAM Identity Center
49+
sort: IAM Identity Center
50+
version: "2020-07-20"

‎.doc_gen/metadata/account_aws_account_metadata.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
account_GettingStarted_077:
2+
title: Managing your account
3+
title_abbrev: Managing your account
4+
synopsis_list:
5+
- Update account name
6+
category: Scenarios
7+
languages:
8+
Bash:
9+
versions:
10+
- sdk_version: 2
11+
github_name: "Sample developer tutorials"
12+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/077-aws-account-management-gs
13+
excerpts:
14+
- description:
15+
snippet_files:
16+
- tuts/077-aws-account-management-gs/aws-account-management-gs.sh
17+
services:
18+
account: {GetAlternateContact, GetContactInformation, GetRegionOptStatus, ListRegions}
19+
s3: {ListBuckets}
20+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/chime_sdk_voice_chimesdk_routingcalls_metadata.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
chime_sdk_voice_GettingStarted_007:
2+
title: Routing calls to Lambda functions for Amazon Chime SDK PSTN audio
3+
title_abbrev: Routing calls to Lambda functions for Amazon Chime SDK PSTN audio
4+
synopsis_list:
5+
- Create a Lambda function for call handling
6+
- Create a SIP media application
7+
- Set up call routing with SIP rules
8+
- Set up redundancy with multiple SIP media applications
9+
- Create outbound calls
10+
- Clean up resources
11+
category: Scenarios
12+
languages:
13+
Bash:
14+
versions:
15+
- sdk_version: 2
16+
github_name: "Sample developer tutorials"
17+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/007-chimesdk-routingcalls
18+
excerpts:
19+
- description:
20+
snippet_files:
21+
- tuts/007-chimesdk-routingcalls/chimesdk-routingcalls.sh
22+
services:
23+
chime-sdk-voice: {CreatePhoneNumberOrder, CreateSipMediaApplication, CreateSipMediaApplicationCall, CreateSipRule, DeleteSipMediaApplication, DeleteSipRule, ListPhoneNumbers, ListSipMediaApplications, ListSipRules, SearchAvailablePhoneNumbers, UpdateSipMediaApplicationCall}
24+
iam: {AttachRolePolicy, CreateRole, DeleteRole, DetachRolePolicy, GetRole}
25+
lambda: {AddPermission, CreateFunction, DeleteFunction, GetFunction}
26+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/datazone_amazon_datazone_metadata.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
datazone_GettingStarted_059:
2+
title: Getting started with Amazon DataZone
3+
title_abbrev: Getting started with Amazon DataZone
4+
synopsis_list:
5+
- Create an Amazon DataZone domain
6+
- Create projects
7+
- Create an environment profile and environment
8+
- Create a data source for Glue
9+
- Create and publish custom assets
10+
- Clean up resources
11+
category: Scenarios
12+
languages:
13+
Bash:
14+
versions:
15+
- sdk_version: 2
16+
github_name: "Sample developer tutorials"
17+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/059-amazon-datazone-gs
18+
excerpts:
19+
- description:
20+
snippet_files:
21+
- tuts/059-amazon-datazone-gs/amazon-datazone-gs.sh
22+
services:
23+
datazone: {AcceptSubscriptionRequest, CreateAsset, CreateAssetType, CreateDataSource, CreateDomain, CreateEnvironment, CreateEnvironmentProfile, CreateFormType, CreateListingChangeSet, CreateProject, CreateSubscriptionRequest, DeleteAsset, DeleteAssetType, DeleteDataSource, DeleteDomain, DeleteEnvironment, DeleteEnvironmentProfile, DeleteFormType, DeleteProject, DeleteSubscriptionRequest, GetAssetType, GetDomain, GetEnvironment, ListEnvironmentBlueprints, SearchListings}
24+
glue: {CreateDatabase, GetDatabases}
25+
iam: {AttachRolePolicy, CreateRole, GetRole, PutRolePolicy}
26+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/ec2_aws_database_metadata.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
ec2_GettingStarted_075:
2+
title: Getting started with Database Migration Service
3+
title_abbrev: Getting started with Database Migration Service
4+
synopsis_list:
5+
- Create a VPC for your migration resources
6+
- Create database parameter groups
7+
- Create source and target databases
8+
- Create an EC2 client instance
9+
- Create a replication instance
10+
- Create source and target endpoints
11+
- Create and start a migration task
12+
category: Scenarios
13+
languages:
14+
Bash:
15+
versions:
16+
- sdk_version: 2
17+
github_name: "Sample developer tutorials"
18+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/075-aws-database-migration-service-gs
19+
excerpts:
20+
- description:
21+
snippet_files:
22+
- tuts/075-aws-database-migration-service-gs/aws-database-migration-service-gs.sh
23+
services:
24+
dms: {CreateEndpoint, CreateReplicationInstance, CreateReplicationSubnetGroup, CreateReplicationTask, DeleteEndpoint, DeleteReplicationInstance, DeleteReplicationSubnetGroup, DeleteReplicationTask, DescribeReplicationInstances, DescribeReplicationTasks, DescribeTableStatistics, StartReplicationTask, TestConnection}
25+
ec2: {AssociateRouteTable, AttachInternetGateway, AuthorizeSecurityGroupIngress, CreateInternetGateway, CreateKeyPair, CreateRoute, CreateRouteTable, CreateSubnet, CreateVpc, DeleteInternetGateway, DeleteKeyPair, DeleteRouteTable, DeleteSubnet, DeleteVpc, DescribeAvailabilityZones, DescribeImages, DescribeInstanceTypeOfferings, DescribeInstances, DescribeSecurityGroups, DescribeSubnets, DescribeVpcs, DetachInternetGateway, ModifyVpcAttribute, RunInstances, TerminateInstances, Wait}
26+
rds: {CreateDbInstance, CreateDbParameterGroup, CreateDbSubnetGroup, DeleteDbInstance, DeleteDbParameterGroup, DeleteDbSubnetGroup, DescribeDbInstances, ModifyDbParameterGroup, Wait}
27+
secrets-manager: {CreateSecret, DeleteSecret, GetSecretValue}
28+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/ec2_aws_network_metadata.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
ec2_GettingStarted_047:
2+
title: Getting started with Network Firewall
3+
title_abbrev: Getting started with Network Firewall
4+
synopsis_list:
5+
- Create rule groups
6+
- Create a firewall policy
7+
- Create a firewall
8+
- Update route tables
9+
- Clean up resources
10+
category: Scenarios
11+
languages:
12+
Bash:
13+
versions:
14+
- sdk_version: 2
15+
github_name: "Sample developer tutorials"
16+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/047-aws-network-firewall-gs
17+
excerpts:
18+
- description:
19+
snippet_files:
20+
- tuts/047-aws-network-firewall-gs/aws-network-firewall-gs.sh
21+
services:
22+
ec2: {CreateRoute, CreateRouteTable, DeleteRoute, DeleteRouteTable, DescribeInternetGateways, DescribeRouteTables, DescribeSubnets, DescribeVpcs}
23+
network-firewall: {CreateFirewall, CreateFirewallPolicy, CreateRuleGroup, DeleteFirewall, DeleteFirewallPolicy, DeleteRuleGroup, DescribeFirewall}
24+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/iam_qbusiness_anon_metadata.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
iam_GettingStarted_042:
2+
title: Creating an Amazon Q Business application environment for anonymous access
3+
title_abbrev: Creating an Amazon Q Business application environment for anonymous access
4+
synopsis_list:
5+
- Create an IAM role for Amazon Q Business
6+
- Create an Amazon Q Business application with anonymous access
7+
- Verify the application creation
8+
- Clean up resources
9+
category: Scenarios
10+
languages:
11+
Bash:
12+
versions:
13+
- sdk_version: 2
14+
github_name: "Sample developer tutorials"
15+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/042-qbusiness-anon
16+
excerpts:
17+
- description:
18+
snippet_files:
19+
- tuts/042-qbusiness-anon/qbusiness-anon.sh
20+
services:
21+
iam: {AttachRolePolicy, CreateRole, DeleteRole, DetachRolePolicy}
22+
qbusiness: {CreateApplication, DeleteApplication, GetApplication}

‎.doc_gen/metadata/iam_qbusiness_ica_metadata.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
iam_GettingStarted_040:
2+
title: Creating an Amazon Q Business application
3+
title_abbrev: Creating an Amazon Q Business application
4+
synopsis_list:
5+
- Set up IAM Identity Center
6+
- Create IAM roles and policies
7+
- Create a user in IAM Identity Center
8+
- Create an Amazon Q Business application
9+
- Enable creator mode (LLM direct chat)
10+
- Assign the user to the application
11+
- Create a user subscription
12+
category: Scenarios
13+
languages:
14+
Bash:
15+
versions:
16+
- sdk_version: 2
17+
github_name: "Sample developer tutorials"
18+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/040-qbusiness-ica
19+
excerpts:
20+
- description:
21+
snippet_files:
22+
- tuts/040-qbusiness-ica/qbusiness-ica.sh
23+
services:
24+
iam: {AttachRolePolicy, CreatePolicy, CreateRole, DeletePolicy, DeleteRole, DetachRolePolicy, GetRole}
25+
qbusiness: {CreateApplication, CreateSubscription, DeleteApplication, GetApplication, ListSubscriptions, UpdateChatControlsConfiguration}
26+
sso-admin: {CreateApplicationAssignment, DeleteApplicationAssignment, ListApplications, ListInstances}

‎.doc_gen/metadata/kinesisvideo_amazon_kinesis_metadata.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
kinesisvideo_GettingStarted_054:
2+
title: Getting started with Amazon Kinesis Video Streams
3+
title_abbrev: Getting started with Amazon Kinesis Video Streams
4+
synopsis_list:
5+
- Create a Kinesis video stream
6+
- Verify stream creation
7+
- Get data endpoints
8+
- Send data to your Kinesis video stream
9+
- Clean up resources
10+
category: Scenarios
11+
languages:
12+
Bash:
13+
versions:
14+
- sdk_version: 2
15+
github_name: "Sample developer tutorials"
16+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/054-amazon-kinesis-video-streams-gs
17+
excerpts:
18+
- description:
19+
snippet_files:
20+
- tuts/054-amazon-kinesis-video-streams-gs/amazon-kinesis-video-streams-gs.sh
21+
services:
22+
kinesisvideo: {CreateStream, DeleteStream, DescribeStream, GetDataEndpoint, ListStreams}

‎.doc_gen/metadata/mq_amazon_mq_metadata.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
mq_GettingStarted_043:
2+
title: Getting started with Amazon MQ for ActiveMQ and Secrets Manager
3+
title_abbrev: Getting started with Amazon MQ for ActiveMQ and Secrets Manager
4+
synopsis_list:
5+
- Store broker credentials in Secrets Manager
6+
- Create an Amazon MQ broker
7+
- Wait for the broker to be in RUNNING state
8+
- Get broker connection details
9+
- Configure security group for the broker
10+
- Create a Java application to connect to the broker
11+
- Build and run the application
12+
category: Scenarios
13+
languages:
14+
Bash:
15+
versions:
16+
- sdk_version: 2
17+
github_name: "Sample developer tutorials"
18+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/043-amazon-mq-gs
19+
excerpts:
20+
- description:
21+
snippet_files:
22+
- tuts/043-amazon-mq-gs/amazon-mq-gs.sh
23+
services:
24+
ec2: {AuthorizeSecurityGroupIngress}
25+
mq: {CreateBroker, DeleteBroker, DescribeBroker}
26+
secrets-manager: {CreateSecret, DeleteSecret}

0 commit comments

Comments
 (0)