AWS managedservices documentation change
Summary
Restructured documentation to clarify onboarding process for AppRegistry, added detailed application creation methods (console/CloudFormation/automation), updated tag requirements, and expanded permissions guidance. Enhanced severity customization explanations and improved code examples.
Security assessment
Changes focus on documentation structure, onboarding procedures, and configuration details without addressing security vulnerabilities. While permissions are discussed, this is standard access control guidance rather than a response to a security incident.
Diff
diff --git a/managedservices/latest/accelerate-guide/app-aware-inc-notifications.md b/managedservices/latest/accelerate-guide/app-aware-inc-notifications.md index 66ffd33ac..adc8abaa9 100644 --- a/managedservices/latest/accelerate-guide/app-aware-inc-notifications.md +++ b/managedservices/latest/accelerate-guide/app-aware-inc-notifications.md @@ -5 +5 @@ -Case enrichmentAMS communications attributesPermissions +Onboard to AppRegistry and create applicationsCreate tags to enable case enrichmentCustomize AMS support case severity for your applicationsReview required permissions @@ -9 +9 @@ Case enrichmentAMS communications attributesPermissions -Learn about AMS Accelerate monitoring defaults. For more information, see [Monitoring and event management in AMS Accelerate](./acc-mon-event-mgmt.html). +Use application aware automated incident notifications to customize your communication experience for support cases that AMS creates on your behalf. When you use this feature, AMS retrieves custom workload preferences from [AWS Service Catalog AppRegistry](https://docs.aws.amazon.com/servicecatalog/latest/arguide/intro-app-registry.html) to enrich your AMS incident communications with metadata about your applications and to customize the severity of support cases created by AMS on your behalf. To use this feature, you must first onboard to AWS Service Catalog AppRegistry. @@ -11 +11 @@ Learn about AMS Accelerate monitoring defaults. For more information, see [Monit -Use application-aware automated incident notifications to retrieve custom workload preferences from [AppRegistry](https://docs.aws.amazon.com/servicecatalog/latest/arguide/intro-app-registry.html) and customize your communication experience. AppRegistry lets you enrich your incident communications with metadata we send about the your applications, and customize support case severity based on criticality. +To learn more about AMS Accelerate monitoring defaults, see [Monitoring and event management in AMS Accelerate](./acc-mon-event-mgmt.html). @@ -13 +13 @@ Use application-aware automated incident notifications to retrieve custom worklo -## Case enrichment +## Onboard to AppRegistry and create applications @@ -15 +15 @@ Use application-aware automated incident notifications to retrieve custom worklo -AMS can retrieve metadata from onboarded applications and enrich the support cases we create on your behalf. In order to do this, you need to: +To onboard to AppRegistry, see [Getting started with AppRegistry](https://docs.aws.amazon.com/servicecatalog/latest/arguide/getting-started-ar.html) in the _AWS Service Catalog AppRegistry Administrator Guide_. After onboarding, use one of the following methods to create applications: @@ -17 +17 @@ AMS can retrieve metadata from onboarded applications and enrich the support cas - 1. Onboard your application to AppRegistry and create applications in AppRegistry. + 1. **AWS console:** To learn more about creating an application in AppRegistry through the AWS console, see [Creating Applications](https://docs.aws.amazon.com/servicecatalog/latest/arguide/create-apps.html) in the _AWS Service Catalog AppRegistry Administrator Guide_. @@ -19 +19 @@ AMS can retrieve metadata from onboarded applications and enrich the support cas - 2. Tag the applications appropriately. + 2. **CloudFormation:** You can define your AppRegistry application just like you define any other resource. For more information, see [AWS Service Catalog AppRegistry resource type reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ServiceCatalogAppRegistry.html) in the _AWS CloudFormation User Guide_. @@ -20,0 +21 @@ AMS can retrieve metadata from onboarded applications and enrich the support cas + 3. **AMS automation:** To simplify the application registration process, AMS provides you with the SSM automation document `AWSManagedServices-CreateAppRegistryApplication`. To use this method, invoke the document from the AWS Systems Manager console at [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/), or with the AWS CLI as described in the following example. @@ -22,13 +23 @@ AMS can retrieve metadata from onboarded applications and enrich the support cas - - -### Onboard your application to AppRegistry and create applications - -See [Getting started with AppRegistry](https://docs.aws.amazon.com/servicecatalog/latest/arguide/getting-started-ar.html). When you are ready, you can start creating applications in three ways: - - 1. AWS console: To learn more about creating an application in AppRegistry through the AWS console, see the AppRegistry documentation [Creating Applications](https://docs.aws.amazon.com/servicecatalog/latest/arguide/create-apps.html) page. - - 2. CloudFormation: You can define your AppRegistry application just like you define any other resources, for more information about this, see the [AWS Service Catalog AppRegistry resource type reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ServiceCatalogAppRegistry.html) page. - - 3. AMS automation: AMS provides you with the SSM automation document `AWSManagedServices-CreateAppRegistryApplication` document to simplify the application registration process. To use this, invoke the document from the [https://console.aws.amazon.com/systems-manager/](https://console.aws.amazon.com/systems-manager/) or with the AWS CLI as follows. - - # This registers a new application with customized severity + # The following registers a new application with customized severity @@ -39 +28 @@ See [Getting started with AppRegistry](https://docs.aws.amazon.com/servicecatalo - # This registers a new application with no customizations + # The following registers a new application with no customizations @@ -53 +42 @@ See [Getting started with AppRegistry](https://docs.aws.amazon.com/servicecatalo -#### Required tags +## Create tags to enable case enrichment @@ -55 +44 @@ See [Getting started with AppRegistry](https://docs.aws.amazon.com/servicecatalo -We require your applications to be tagged properly for us to be able to access its metadata. The required tags are provided in the following table. +You must tag your applications before AMS can access application metadata. The following table lists the required tags. @@ -64 +53 @@ ams:rt:ams-managed | true -## AMS communications attributes +## Customize AMS support case severity for your applications @@ -66 +55 @@ ams:rt:ams-managed | true -You can customize the severity of AMS created support cases by specifying how critical is your application for your organization. This is controlled by an attribute group associated with your application on AppRegistry. The name of the attribute group name must match the following pattern: +You can customize the severity of AMS created support cases by specifying how critical your application is for your organization. This setting is controlled by an attribute group associated with your application in AppRegistry. The name of the attribute group name must match the following pattern: @@ -71 +60 @@ You can customize the severity of AMS created support cases by specifying how cr -Where the <ApplicationName> matches the name used in AppRegistry when creating the application. +In the preceding pattern, the `ApplicationName` must match the name used in AppRegistry when you created the application. @@ -81 +70 @@ Example content: -_SchemaVersion_ +**SchemaVersion** @@ -83 +72 @@ _SchemaVersion_ -This determines what schema version you're using. This determines the subset of features available to use. +This determines the schema version that you're using and the subset of features available to use. @@ -89 +78 @@ Schema version | Feature -_Criticality_ +**Criticality** @@ -91 +80 @@ _Criticality_ -The criticality of this application determines how important it is for your organization. This criticality also determines the severity of the support cases created by the AMS automated systems. +The criticality of this application determines the severity of the support cases created by the AMS automated systems. @@ -98 +87 @@ Valid values: -To understand the severity levels, see [SeverityLevel](https://docs.aws.amazon.com/awssupport/latest/APIReference/API_SeverityLevel.html). +For more information on severity levels, see [SeverityLevel](https://docs.aws.amazon.com/awssupport/latest/APIReference/API_SeverityLevel.html) in the _AWS Support API Reference_. @@ -102 +91 @@ Required: Yes -## Permissions +## Review required permissions @@ -123 +112 @@ To use this feature, AMS requires access to the following AWS Identity and Acces -Make sure that there is not an IAM policy or Service Control Policy that denies the preceding actions. +Make sure that there isn't an IAM policy or service control policy (SCP) that denies the preceding actions. @@ -125 +114 @@ Make sure that there is not an IAM policy or Service Control Policy that denies -The API calls made by the `ams-access-admin` role. Example of what you might see: +The API calls are made by the `ams-access-admin` role. The following is an example of what you might see: