Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .doc_gen/metadata/config-service_metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ config-service_PutConfigRule:
excerpts:
- description:
snippet_tags:
- python.example_code.config-service.ConfigWrapper
- python.example_code.config.ConfigWrapper
- python.example_code.config-service.PutConfigRule
services:
config-service: {PutConfigRule}
Expand All @@ -23,7 +23,7 @@ config-service_DescribeConfigRules:
excerpts:
- description:
snippet_tags:
- python.example_code.config-service.ConfigWrapper
- python.example_code.config.ConfigWrapper
- python.example_code.config-service.DescribeConfigRules
services:
config-service: {DescribeConfigRules}
Expand All @@ -37,7 +37,7 @@ config-service_DeleteConfigRule:
excerpts:
- description:
snippet_tags:
- python.example_code.config-service.ConfigWrapper
- python.example_code.config.ConfigWrapper
- python.example_code.config-service.DeleteConfigRule
services:
config-service: {DeleteConfigRule}
195 changes: 195 additions & 0 deletions .doc_gen/metadata/config_metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
# zexi 0.4.0
config_PutConfigurationRecorder:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it edited the old file and made a new one. We should decide which to keep.

languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.PutConfigurationRecorder
services:
config-service: {PutConfigurationRecorder}
config_PutDeliveryChannel:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.PutDeliveryChannel
services:
config-service: {PutDeliveryChannel}
config_StartConfigurationRecorder:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.StartConfigurationRecorder
services:
config-service: {StartConfigurationRecorder}
config_DescribeConfigurationRecorders:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.DescribeConfigurationRecorders
services:
config-service: {DescribeConfigurationRecorders}
config_DescribeConfigurationRecorderStatus:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.DescribeConfigurationRecorderStatus
services:
config-service: {DescribeConfigurationRecorderStatus}
config_ListDiscoveredResources:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.ListDiscoveredResources
services:
config-service: {ListDiscoveredResources}
config_GetResourceConfigHistory:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.GetResourceConfigHistory
services:
config-service: {GetResourceConfigHistory}
config_StopConfigurationRecorder:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.StopConfigurationRecorder
services:
config-service: {StopConfigurationRecorder}
config_DeleteConfigurationRecorder:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.DeleteConfigurationRecorder
services:
config-service: {DeleteConfigurationRecorder}
config_DeleteDeliveryChannel:
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.DeleteDeliveryChannel
services:
config-service: {DeleteDeliveryChannel}
config_Hello:
title: Hello &Config;
title_abbrev: Hello &Config;
synopsis: get started using &Config; by listing existing configuration recorders.
category: Hello
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description:
snippet_tags:
- python.example_code.config.HelloConfig
services:
config-service: {DescribeConfigurationRecorders}
config_Scenario:
title: Get started with &Config; using an &AWS; SDK
title_abbrev: Get started with &Config;
synopsis_list:
- Create a configuration recorder to track &AWS; resource configurations.
- Set up a delivery channel to specify where &Config; sends configuration snapshots.
- Start the configuration recorder to begin monitoring resources.
- Monitor configuration recorder status and settings.
- Discover &AWS; resources in your account.
- View configuration history for specific resources.
- Clean up &Config; resources.
category: Scenarios
languages:
Python:
versions:
- sdk_version: 3
github: python/example_code/config
sdkguide:
excerpts:
- description: Create a wrapper class for &Config; operations.
snippet_tags:
- python.example_code.config.ConfigWrapper
- python.example_code.config.PutConfigurationRecorder
- python.example_code.config.PutDeliveryChannel
- python.example_code.config.StartConfigurationRecorder
- python.example_code.config.DescribeConfigurationRecorders
- python.example_code.config.DescribeConfigurationRecorderStatus
- python.example_code.config.ListDiscoveredResources
- python.example_code.config.GetResourceConfigHistory
- python.example_code.config.StopConfigurationRecorder
- python.example_code.config.DeleteConfigurationRecorder
- python.example_code.config.DeleteDeliveryChannel
- description: Run a comprehensive scenario demonstrating &Config; setup and resource monitoring.
snippet_tags:
- python.example_code.config.Scenario_ConfigBasics
services:
config-service: {PutConfigurationRecorder, PutDeliveryChannel, StartConfigurationRecorder, DescribeConfigurationRecorders, DescribeConfigurationRecorderStatus, ListDiscoveredResources, GetResourceConfigHistory, StopConfigurationRecorder, DeleteConfigurationRecorder, DeleteDeliveryChannel}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Package.resolved
build_dir
node_modules
super-linter.log
debug.log
target
vendor
venv
Expand Down
2 changes: 1 addition & 1 deletion .tools/readmes/render.py
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ def render(self) -> RenderStatus:
self.readme_text += "\n" # Jinja is the worst and strips trailing new lines
[text, errors] = expand_all_entities(self.readme_text, self.scanner.doc_gen.entities)
if errors:
raise errors
raise RuntimeError(f"Entity expansion errors: {errors}")
self.readme_text = text

# Check if the rendered text is different from the existing file
Expand Down
21 changes: 21 additions & 0 deletions python/example_code/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,28 @@ Code excerpts that show you how to call individual service functions.

- [DeleteConfigRule](config_rules.py#L89)
- [DescribeConfigRules](config_rules.py#L67)
- [DescribeConfigurationRecorders](config_rules.py#L150)
- [DescribeConfigurationRecorderStatus](config_rules.py#L175)
- [GetResourceConfigHistory](config_rules.py#L225)
- [ListDiscoveredResources](config_rules.py#L200)
- [PutConfigRule](config_rules.py#L34)
- [PutConfigurationRecorder](config_rules.py#L105)
- [PutDeliveryChannel](config_rules.py#L130)
- [StartConfigurationRecorder](config_rules.py#L155)
- [StopConfigurationRecorder](config_rules.py#L250)

### Hello

Code example that shows you how to get started using the service.

- [Hello AWS Config](config_hello.py)

### Scenarios

Code examples that show you how to accomplish a specific task by calling multiple
functions within the same service.

- [Get started with AWS Config](config_basics.py)


<!--custom.examples.start-->
Expand Down
Loading
Loading