awsdocs / aws-doc-sdk-examples

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.
Apache License 2.0
9.5k stars 5.61k forks source link

[NEW EXAMPLE] <<Language>> <<Service>> <<Description of Examples>> #2615

Closed elimuhub7407 closed 2 years ago

elimuhub7407 commented 2 years ago

Each example should contain the following metadata. Some of the fields like keyword and service can be used multiple times as needed. For snippet-service, use the AWS Service Namespace as listed in our General Reference. If the example uses multiple services, be sure to include each service on a separate line.

Use comment denotations appropriate for each langague. Example Metadata and License:

/**
 * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * This file is licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License. A copy of
 * the License is located at
 *
 * http://aws.amazon.com/apache2.0/
 *
 * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
*/
// snippet-comment:[These are tags for the AWS doc team's sample catalog. Do not remove.]
// snippet-sourcedescription:[<<FILENAME>> demonstrates how to ...]
// snippet-service:[<<ADD SHORT SERVICE NAME>>]
// snippet-sourcesyntax:[<<LANGUAGE>>]
// snippet-keyword:[<<LANGUAGE>>]
// snippet-keyword:[<<ADD FULL SERVICE NAME>>]
// snippet-keyword:[Code Sample]
// snippet-keyword:[<<API OPERATION>>]
// snippet-sourcetype:[snippet] or snippet-sourcetype:[full-example]
// snippet-sourcedate:[YYYY-MM-DD]
// snippet-sourceauthor:[<<YOUR USERNAME>>]
// snippet-start:[service.language.unique_name.complete]

<your code>

// snippet-end:[service.language.unique_name.complete]

Please answer the following questions about the examples submitted to help us process the Pull request efficiently.

Did you add the metadata as described above?

How were these examples tested?

If necessary, how do I build/compile the example?

If necessary, how do I run the example?

Are there any required inputs?

What output should I expect?

Are there any hard-coded values that might need changing?

scmacdon commented 2 years ago

We have tags in Java V2 examples