From f48786f02a85b63d800a3f204c93a12db18d8055 Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 13:22:48 +0000 Subject: [PATCH 1/9] Add new service metadata yaml files --- .doc_gen/metadata/chime_metadata.yaml | 31 +++++++++++++++++ .doc_gen/metadata/cloudfront_metadata.yaml | 31 +++++++++++++++++ .doc_gen/metadata/fargate_metadata.yaml | 33 +++++++++++++++++++ .doc_gen/metadata/lightsail_metadata.yaml | 25 ++++++++++++++ .../vpc_transit_gateway_metadata.yaml | 25 ++++++++++++++ 5 files changed, 145 insertions(+) create mode 100644 .doc_gen/metadata/chime_metadata.yaml create mode 100644 .doc_gen/metadata/cloudfront_metadata.yaml create mode 100644 .doc_gen/metadata/fargate_metadata.yaml create mode 100644 .doc_gen/metadata/lightsail_metadata.yaml create mode 100644 .doc_gen/metadata/vpc_transit_gateway_metadata.yaml diff --git a/.doc_gen/metadata/chime_metadata.yaml b/.doc_gen/metadata/chime_metadata.yaml new file mode 100644 index 00000000..811af465 --- /dev/null +++ b/.doc_gen/metadata/chime_metadata.yaml @@ -0,0 +1,31 @@ +chime_GettingStarted: + title: Routing calls to AWS Lambda functions for Amazon Chime SDK PSTN audio + title_abbrev: Get started with Chime SDK PSTN routing + synopsis_list: + - Search for and provision phone numbers for call routing + - Create Lambda functions for call handling with IAM roles + - Create SIP media applications to connect Lambda to PSTN + - Set up SIP rules for routing calls based on phone numbers or hostnames + - Configure redundancy with multiple SIP media applications + - Create outbound calls and trigger Lambda during active calls + - Clean up resources including SIP rules, applications, and Lambda functions + category: Scenarios + languages: + Bash: + versions: + - sdk_version: 2 + github_name: "Sample developer tutorials" + github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/007-chimesdk-routingcalls + excerpts: + - description: + snippet_files: + - tuts/007-chimesdk-routingcalls/chimesdk-routingcalls.sh + services: + chime-sdk-voice: { + SearchAvailablePhoneNumbers, CreatePhoneNumberOrder, GetPhoneNumberOrder, ListPhoneNumbers, DeletePhoneNumber, CreateSipMediaApplication, ListSipMediaApplications, DeleteSipMediaApplication, CreateSipRule, ListSipRules, UpdateSipRule, DeleteSipRule, CreateSipMediaApplicationCall, UpdateSipMediaApplicationCall} + lambda: { + CreateFunction, GetFunction, DeleteFunction, AddPermission} + iam: { + CreateRole, GetRole, AttachRolePolicy, DetachRolePolicy, DeleteRole} + sts: { + GetCallerIdentity} diff --git a/.doc_gen/metadata/cloudfront_metadata.yaml b/.doc_gen/metadata/cloudfront_metadata.yaml new file mode 100644 index 00000000..3a7ab4f1 --- /dev/null +++ b/.doc_gen/metadata/cloudfront_metadata.yaml @@ -0,0 +1,31 @@ +cloudfront_GettingStarted: + title: Get started with a basic CloudFront distribution using the AWS CLI + title_abbrev: Get started with CloudFront + synopsis_list: + - Create an Amazon S3 bucket for content storage + - Upload sample content to the S3 bucket + - Create an origin access control (OAC) for secure S3 access + - Create a CloudFront distribution with S3 as origin + - Update S3 bucket policy to allow CloudFront access + - Wait for distribution deployment and test content access + - Clean up resources including distribution, OAC, and S3 bucket + category: Scenarios + languages: + Bash: + versions: + - sdk_version: 2 + github_name: "Sample developer tutorials" + github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/005-cloudfront-gettingstarted + excerpts: + - description: + snippet_files: + - tuts/005-cloudfront-gettingstarted/cloudfront-gettingstarted.sh + services: + cloudfront: { + CreateOriginAccessControl, GetOriginAccessControl, DeleteOriginAccessControl, CreateDistribution, GetDistribution, GetDistributionConfig, UpdateDistribution, DeleteDistribution, WaitDistributionDeployed} + s3: { + CreateBucket, PutObject, DeleteObject, DeleteBucket} + s3api: { + PutBucketPolicy} + sts: { + GetCallerIdentity} diff --git a/.doc_gen/metadata/fargate_metadata.yaml b/.doc_gen/metadata/fargate_metadata.yaml new file mode 100644 index 00000000..15a34a2c --- /dev/null +++ b/.doc_gen/metadata/fargate_metadata.yaml @@ -0,0 +1,33 @@ +fargate_GettingStarted: + title: Get started with AWS Batch and Fargate using the CLI + title_abbrev: Get started with Batch and Fargate + synopsis_list: + - Create an IAM execution role for ECS tasks + - Create a managed Fargate compute environment + - Create a job queue with priority settings + - Register a job definition for containerized workloads + - Submit and monitor a batch job execution + - View job output in CloudWatch Logs + - Clean up resources in proper dependency order + category: Scenarios + languages: + Bash: + versions: + - sdk_version: 2 + github_name: "Sample developer tutorials" + github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/011-getting-started-batch-fargate + excerpts: + - description: + snippet_files: + - tuts/011-getting-started-batch-fargate/getting-started-batch-fargate.sh + services: + batch: { + CreateComputeEnvironment, DescribeComputeEnvironments, CreateJobQueue, DescribeJobQueues, RegisterJobDefinition, SubmitJob, DescribeJobs, UpdateJobQueue, DeleteJobQueue, UpdateComputeEnvironment, DeleteComputeEnvironment} + iam: { + CreateRole, AttachRolePolicy, DetachRolePolicy, DeleteRole} + ec2: { + DescribeVpcs, DescribeSubnets, DescribeSecurityGroups} + logs: { + GetLogEvents} + sts: { + GetCallerIdentity} diff --git a/.doc_gen/metadata/lightsail_metadata.yaml b/.doc_gen/metadata/lightsail_metadata.yaml new file mode 100644 index 00000000..6648b1f9 --- /dev/null +++ b/.doc_gen/metadata/lightsail_metadata.yaml @@ -0,0 +1,25 @@ +lightsail_GettingStarted: + title: Get started with Amazon Lightsail using the CLI + title_abbrev: Get started with Lightsail + synopsis_list: + - Explore available blueprints and bundles for instance creation + - Create a Lightsail instance with Amazon Linux 2023 + - Monitor instance status until running + - Download default key pair for SSH access + - Create and attach additional block storage disk + - Create an instance snapshot for backup + - Clean up resources to avoid ongoing charges + category: Scenarios + languages: + Bash: + versions: + - sdk_version: 2 + github_name: "Sample developer tutorials" + github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/001-lightsail-gs + excerpts: + - description: + snippet_files: + - tuts/001-lightsail-gs/lightsail-gs.sh + services: + lightsail: { + GetBlueprints, GetBundles, CreateInstances, GetInstanceState, GetInstance, DownloadDefaultKeyPair, CreateDisk, GetDisk, AttachDisk, DetachDisk, CreateInstanceSnapshot, GetInstanceSnapshot, DeleteInstanceSnapshot, DeleteDisk, DeleteInstance} diff --git a/.doc_gen/metadata/vpc_transit_gateway_metadata.yaml b/.doc_gen/metadata/vpc_transit_gateway_metadata.yaml new file mode 100644 index 00000000..15584f25 --- /dev/null +++ b/.doc_gen/metadata/vpc_transit_gateway_metadata.yaml @@ -0,0 +1,25 @@ +vpc_TransitGatewayGettingStarted: + title: Get started with AWS Transit Gateway using the CLI + title_abbrev: Get started with Transit Gateway + synopsis_list: + - Create a transit gateway with DNS support and default route table settings + - Wait for the transit gateway to become available + - Attach two VPCs to the transit gateway using subnets + - Wait for VPC attachments to become available + - Add routes between VPCs through the transit gateway + - Test connectivity between VPC resources + - Clean up resources including routes, attachments, and transit gateway + category: Scenarios + languages: + Bash: + versions: + - sdk_version: 2 + github_name: "Sample developer tutorials" + github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/012-transitgateway-gettingstarted + excerpts: + - description: + snippet_files: + - tuts/012-transitgateway-gettingstarted/transitgateway-gettingstarted.sh + services: + ec2: { + CreateTransitGateway, DescribeTransitGateways, CreateTransitGatewayVpcAttachment, DescribeTransitGatewayVpcAttachments, DescribeTransitGatewayAttachments, CreateRoute, DeleteRoute, DeleteTransitGatewayVpcAttachment, DeleteTransitGateway, DescribeAvailabilityZones, CreateVpc, DescribeVpcs, CreateSubnet, DescribeSubnets, DescribeRouteTables} From d4842c60904f2aec382549645da74f7b9e4fb442 Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 13:26:17 +0000 Subject: [PATCH 2/9] Removing 'aws' --- .doc_gen/metadata/chime_metadata.yaml | 2 +- .doc_gen/metadata/vpc_transit_gateway_metadata.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.doc_gen/metadata/chime_metadata.yaml b/.doc_gen/metadata/chime_metadata.yaml index 811af465..3dc0a1c3 100644 --- a/.doc_gen/metadata/chime_metadata.yaml +++ b/.doc_gen/metadata/chime_metadata.yaml @@ -1,5 +1,5 @@ chime_GettingStarted: - title: Routing calls to AWS Lambda functions for Amazon Chime SDK PSTN audio + title: Routing calls to Lambda functions for Amazon Chime SDK PSTN audio title_abbrev: Get started with Chime SDK PSTN routing synopsis_list: - Search for and provision phone numbers for call routing diff --git a/.doc_gen/metadata/vpc_transit_gateway_metadata.yaml b/.doc_gen/metadata/vpc_transit_gateway_metadata.yaml index 15584f25..3db6411b 100644 --- a/.doc_gen/metadata/vpc_transit_gateway_metadata.yaml +++ b/.doc_gen/metadata/vpc_transit_gateway_metadata.yaml @@ -1,5 +1,5 @@ vpc_TransitGatewayGettingStarted: - title: Get started with AWS Transit Gateway using the CLI + title: Get started with Transit Gateway using the CLI title_abbrev: Get started with Transit Gateway synopsis_list: - Create a transit gateway with DNS support and default route table settings From d32095e6707757080922ff2af0507a9a20a09935 Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 13:28:05 +0000 Subject: [PATCH 3/9] Removing 'aws' --- .doc_gen/metadata/fargate_metadata.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.doc_gen/metadata/fargate_metadata.yaml b/.doc_gen/metadata/fargate_metadata.yaml index 15a34a2c..7e8b7145 100644 --- a/.doc_gen/metadata/fargate_metadata.yaml +++ b/.doc_gen/metadata/fargate_metadata.yaml @@ -1,5 +1,5 @@ fargate_GettingStarted: - title: Get started with AWS Batch and Fargate using the CLI + title: Get started with Batch and Fargate using the CLI title_abbrev: Get started with Batch and Fargate synopsis_list: - Create an IAM execution role for ECS tasks From 4541c1e44d2c7eb9d577131c9a201abddc8f48ec Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 13:28:50 +0000 Subject: [PATCH 4/9] Removing 'aws' --- .doc_gen/metadata/cloudfront_metadata.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.doc_gen/metadata/cloudfront_metadata.yaml b/.doc_gen/metadata/cloudfront_metadata.yaml index 3a7ab4f1..bc00512e 100644 --- a/.doc_gen/metadata/cloudfront_metadata.yaml +++ b/.doc_gen/metadata/cloudfront_metadata.yaml @@ -1,5 +1,5 @@ cloudfront_GettingStarted: - title: Get started with a basic CloudFront distribution using the AWS CLI + title: Get started with a basic CloudFront distribution using the CLI title_abbrev: Get started with CloudFront synopsis_list: - Create an Amazon S3 bucket for content storage From 7058ff8c032c4d996aa1787355253a718e0e7d5a Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 13:35:19 +0000 Subject: [PATCH 5/9] Add S3 --- .doc_gen/metadata/cloudfront_metadata.yaml | 2 -- .doc_gen/metadata/s3_metadata.yaml | 27 ++++++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 .doc_gen/metadata/s3_metadata.yaml diff --git a/.doc_gen/metadata/cloudfront_metadata.yaml b/.doc_gen/metadata/cloudfront_metadata.yaml index bc00512e..73689ff7 100644 --- a/.doc_gen/metadata/cloudfront_metadata.yaml +++ b/.doc_gen/metadata/cloudfront_metadata.yaml @@ -25,7 +25,5 @@ cloudfront_GettingStarted: CreateOriginAccessControl, GetOriginAccessControl, DeleteOriginAccessControl, CreateDistribution, GetDistribution, GetDistributionConfig, UpdateDistribution, DeleteDistribution, WaitDistributionDeployed} s3: { CreateBucket, PutObject, DeleteObject, DeleteBucket} - s3api: { - PutBucketPolicy} sts: { GetCallerIdentity} diff --git a/.doc_gen/metadata/s3_metadata.yaml b/.doc_gen/metadata/s3_metadata.yaml new file mode 100644 index 00000000..aee37ea7 --- /dev/null +++ b/.doc_gen/metadata/s3_metadata.yaml @@ -0,0 +1,27 @@ +s3_GettingStarted: + title: Get started with Amazon S3 using the CLI + title_abbrev: Get started with S3 + synopsis_list: + - Create an S3 bucket with unique naming and regional configuration + - Configure bucket security settings including public access blocking + - Enable versioning and default encryption for data protection + - Upload objects with and without custom metadata + - Download objects from the bucket to local storage + - Copy objects within the bucket to organize data in folders + - List bucket contents and objects with specific prefixes + - Add tags to buckets for resource management + - Clean up all resources including versioned objects + category: Scenarios + languages: + Bash: + versions: + - sdk_version: 2 + github_name: "Sample developer tutorials" + github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/003-s3-gettingstarted + excerpts: + - description: + snippet_files: + - tuts/003-s3-gettingstarted/s3-gettingstarted.sh + services: + s3: { + CreateBucket, PutPublicAccessBlock, PutBucketVersioning, PutBucketEncryption, PutObject, GetObject, HeadObject, CopyObject, ListObjectsV2, PutBucketTagging, ListObjectVersions, DeleteObjects, DeleteBucket} From 2796aa9283440fc6f29256639ca81b621c5cf66a Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 13:38:49 +0000 Subject: [PATCH 6/9] Rm chime sdk --- .doc_gen/metadata/chime_metadata.yaml | 31 --------------------------- 1 file changed, 31 deletions(-) delete mode 100644 .doc_gen/metadata/chime_metadata.yaml diff --git a/.doc_gen/metadata/chime_metadata.yaml b/.doc_gen/metadata/chime_metadata.yaml deleted file mode 100644 index 3dc0a1c3..00000000 --- a/.doc_gen/metadata/chime_metadata.yaml +++ /dev/null @@ -1,31 +0,0 @@ -chime_GettingStarted: - title: Routing calls to Lambda functions for Amazon Chime SDK PSTN audio - title_abbrev: Get started with Chime SDK PSTN routing - synopsis_list: - - Search for and provision phone numbers for call routing - - Create Lambda functions for call handling with IAM roles - - Create SIP media applications to connect Lambda to PSTN - - Set up SIP rules for routing calls based on phone numbers or hostnames - - Configure redundancy with multiple SIP media applications - - Create outbound calls and trigger Lambda during active calls - - Clean up resources including SIP rules, applications, and Lambda functions - category: Scenarios - languages: - Bash: - versions: - - sdk_version: 2 - github_name: "Sample developer tutorials" - github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/007-chimesdk-routingcalls - excerpts: - - description: - snippet_files: - - tuts/007-chimesdk-routingcalls/chimesdk-routingcalls.sh - services: - chime-sdk-voice: { - SearchAvailablePhoneNumbers, CreatePhoneNumberOrder, GetPhoneNumberOrder, ListPhoneNumbers, DeletePhoneNumber, CreateSipMediaApplication, ListSipMediaApplications, DeleteSipMediaApplication, CreateSipRule, ListSipRules, UpdateSipRule, DeleteSipRule, CreateSipMediaApplicationCall, UpdateSipMediaApplicationCall} - lambda: { - CreateFunction, GetFunction, DeleteFunction, AddPermission} - iam: { - CreateRole, GetRole, AttachRolePolicy, DetachRolePolicy, DeleteRole} - sts: { - GetCallerIdentity} From 06e513a6930790a98e6b6b12454a7aec0e9126a4 Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 13:39:37 +0000 Subject: [PATCH 7/9] Rm logs --- .doc_gen/metadata/fargate_metadata.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.doc_gen/metadata/fargate_metadata.yaml b/.doc_gen/metadata/fargate_metadata.yaml index 7e8b7145..3e8130d7 100644 --- a/.doc_gen/metadata/fargate_metadata.yaml +++ b/.doc_gen/metadata/fargate_metadata.yaml @@ -27,7 +27,5 @@ fargate_GettingStarted: CreateRole, AttachRolePolicy, DetachRolePolicy, DeleteRole} ec2: { DescribeVpcs, DescribeSubnets, DescribeSecurityGroups} - logs: { - GetLogEvents} sts: { GetCallerIdentity} From cb86c47ac1d1f580272f6f278b4f36a9935c656c Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 14:45:54 +0000 Subject: [PATCH 8/9] Rm ec2 apis from fargate --- .doc_gen/metadata/fargate_metadata.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.doc_gen/metadata/fargate_metadata.yaml b/.doc_gen/metadata/fargate_metadata.yaml index 3e8130d7..a17f9b41 100644 --- a/.doc_gen/metadata/fargate_metadata.yaml +++ b/.doc_gen/metadata/fargate_metadata.yaml @@ -25,7 +25,5 @@ fargate_GettingStarted: CreateComputeEnvironment, DescribeComputeEnvironments, CreateJobQueue, DescribeJobQueues, RegisterJobDefinition, SubmitJob, DescribeJobs, UpdateJobQueue, DeleteJobQueue, UpdateComputeEnvironment, DeleteComputeEnvironment} iam: { CreateRole, AttachRolePolicy, DetachRolePolicy, DeleteRole} - ec2: { - DescribeVpcs, DescribeSubnets, DescribeSecurityGroups} sts: { GetCallerIdentity} From de79c5bc637ca76f7d9a6c77959d205974944f72 Mon Sep 17 00:00:00 2001 From: Geoff McCarthy Date: Sat, 9 Aug 2025 14:50:34 +0000 Subject: [PATCH 9/9] Rm apis not relevant to these services --- .doc_gen/metadata/cloudfront_metadata.yaml | 4 ---- .doc_gen/metadata/fargate_metadata.yaml | 4 ---- 2 files changed, 8 deletions(-) diff --git a/.doc_gen/metadata/cloudfront_metadata.yaml b/.doc_gen/metadata/cloudfront_metadata.yaml index 73689ff7..3b6e95a6 100644 --- a/.doc_gen/metadata/cloudfront_metadata.yaml +++ b/.doc_gen/metadata/cloudfront_metadata.yaml @@ -23,7 +23,3 @@ cloudfront_GettingStarted: services: cloudfront: { CreateOriginAccessControl, GetOriginAccessControl, DeleteOriginAccessControl, CreateDistribution, GetDistribution, GetDistributionConfig, UpdateDistribution, DeleteDistribution, WaitDistributionDeployed} - s3: { - CreateBucket, PutObject, DeleteObject, DeleteBucket} - sts: { - GetCallerIdentity} diff --git a/.doc_gen/metadata/fargate_metadata.yaml b/.doc_gen/metadata/fargate_metadata.yaml index a17f9b41..1caf4efe 100644 --- a/.doc_gen/metadata/fargate_metadata.yaml +++ b/.doc_gen/metadata/fargate_metadata.yaml @@ -23,7 +23,3 @@ fargate_GettingStarted: services: batch: { CreateComputeEnvironment, DescribeComputeEnvironments, CreateJobQueue, DescribeJobQueues, RegisterJobDefinition, SubmitJob, DescribeJobs, UpdateJobQueue, DeleteJobQueue, UpdateComputeEnvironment, DeleteComputeEnvironment} - iam: { - CreateRole, AttachRolePolicy, DetachRolePolicy, DeleteRole} - sts: { - GetCallerIdentity}