# Monitoring and Notification Subcategory **Topics** + [CloudWatch \$1 Enable Non-Root Volumes Monitoring](management-monitoring-cloudwatch-enable-non-root-volumes-monitoring.md) + [CloudWatch \$1 Modify Log Retention Period](management-monitoring-cloudwatch-modify-log-retention-period.md) + [GuardDuty IP Set \$1 Delete (Managed Automation)](management-monitoring-guardduty-ip-set-delete-managed-automation.md) + [GuardDuty IP Set \$1 Update (Managed Automation)](management-monitoring-guardduty-ip-set-update-managed-automation.md) + [GuardDuty Suppression Rules \$1 Create (Managed Automation)](management-monitoring-guardduty-suppression-rules-create-managed-automation.md) + [GuardDuty Threat Intel Set \$1 Delete (Managed Automation)](management-monitoring-guardduty-threat-intel-set-delete-managed-automation.md) + [GuardDuty Threat Intel Set \$1 Update (Managed Automation)](management-monitoring-guardduty-threat-intel-set-update-managed-automation.md) + [SNS \$1 Subscribe To DirectCustomerAlerts](management-monitoring-sns-subscribe-to-directcustomeralerts.md) + [SNS \$1 Update (Managed Automation)](management-monitoring-sns-update-managed-automation.md) + [SQS \$1 Update](management-monitoring-sqs-update.md) # CloudWatch \$1 Enable Non-Root Volumes Monitoring Enable monitoring on non-root volumes of an EC2 instance. **Full classification:** Management \$1 Monitoring and notification \$1 CloudWatch \$1 Enable Non-Root Volumes Monitoring ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-0erkoad6uyvvg | | Current version | 1.0 | | Expected execution duration | 60 minutes | | AWS approval | Required | | Customer approval | Not required | | Execution mode | Automated | ## Additional Information ### Enable CloudWatch non-root volumes monitoring #### Enabling CloudWatch non-root volume monitoring with the console The following shows this change type in the AMS console. ![\[Change type for enabling non-root volumes monitoring on EC2 instances with ID and version.\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiCwEnableNonRootVolMonCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Enabling CloudWatch non-root volume monitoring with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-0erkoad6uyvvg" --change-type-version "1.0" --title "Enable Non-Root Volumes Monitoring" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-DeployNonRootVolumeMonitoring\",\"Region\":\"us-east-1\",\"Parameters\":{\"InstanceId\":[\"i-1234567890abcdef0\"]}}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it CwNonRootVolumeMonitoringParams.json: ``` aws amscm get-change-type-version --change-type-id "ct-0erkoad6uyvvg" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > CwNonRootVolumeMonitoringParams.json ``` 1. Modify and save the CwNonRootVolumeMonitoringParams.json file. For example, you can replace the contents with something like this: ``` { "DocumentName": "AWSManagedServices-DeployNonRootVolumeMonitoring", "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-1234567890abcdef0" ] } } ``` 1. Output the JSON template for CreateRfc to a file in your current folder; this example names it CwNonRootVolumeMonitoringRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > CwNonRootVolumeMonitoringRfc.json ``` 1. Modify and save the CwNonRootVolumeMonitoringRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0erkoad6uyvvg", "Title": "CW-NON-ROOT-VOL-MONITORING-RFC" } ``` 1. Create the RFC, specifying the CwNonRootVolumeMonitoringRfc file and the execution parameters file: ``` aws amscm create-rfc --cli-input-json file://CwNonRootVolumeMonitoringRfc.json --execution-parameters file://CwNonRootVolumeMonitoringParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips To learn more about CloudWatch, see [Enable or disable detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html). The EC2 instance alart `Non-root volume usage` is **DISABLED** by default. If you require alert generation based on this alarm, then you must enable it using this RFC. ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-0erkoad6uyvvg](schemas.md#ct-0erkoad6uyvvg-schema-section). ## Example: Required Parameters ``` { "DocumentName": "AWSManagedServices-DeployNonRootVolumeMonitoring", "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-1234567890abcdef0" ] } } ``` ## Example: All Parameters ``` { "DocumentName": "AWSManagedServices-DeployNonRootVolumeMonitoring", "Region": "us-east-1", "Parameters": { "InstanceId": [ "i-1234567890abcdef0" ] } } ``` # CloudWatch \$1 Modify Log Retention Period Modify the retention period for Amazon CloudWatch log groups. This change performs direct API actions whether or not the CloudWatch log group is part of a stack, which can cause stack drift. **Full classification:** Management \$1 Monitoring and notification \$1 CloudWatch \$1 Modify log retention period ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-0vfx8rwd1mcnn | | Current version | 1.0 | | Expected execution duration | 60 minutes | | AWS approval | Required | | Customer approval | Not required | | Execution mode | Automated | ## Additional Information ### Modify log retention period #### Modifying log retention period with the console The following shows this change type in the AMS console. ![\[alt text not found\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiModifyLogRetentionPeriodCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Modifying log retention period with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotation marks when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-0vfx8rwd1mcnn" --change-type-version "1.0" --title "Modify CloudWatch Log Retention" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-ModifyCloudWatchLogRetentionPeriod\",\"Parameters\":{\"LogGroupNames\":[\"LOG_GROUP_NAME\"],\"RetentionDays\":\"365\"},\"Region\":\"REGION\"}" ``` ``` aws amscm create-rfc --change-type-id "ct-0vfx8rwd1mcnn" --change-type-version "1.0" --title "Modify CloudWatch Log Retention" --execution-parameters "{\"DocumentName\":\"AWSManagedServices-ModifyCloudWatchLogRetentionPeriod\",\"Parameters\":{\"LogGroupNames\":[\"LOG_GROUP_NAME_1\",\"LOG_GROUP_NAME_2\"],\"RetentionDays\":\"90\"},\"Region\":\"REGION\"}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file in your current folder; this example names it validateModifyLogRetention.json: ``` aws amscm get-change-type-version --change-type-id "ct-0vfx8rwd1mcnn" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > validateModifyLogRetention.json ``` 1. Modify and save the validateModifyLogRetention.json file. For example, you can replace the contents with something like this: ``` { "DocumentName": "AWSManagedServices-ModifyCloudWatchLogRetentionPeriod", "Region": "REGION", "Parameters": { "LogGroupNames": ["LOG_GROUP_NAME"], "RetentionDays": "365" } } ``` ``` { "DocumentName": "AWSManagedServices-ModifyCloudWatchLogRetentionPeriod", "Parameters": { "LogGroupNames": [ "LOG_GROUP_NAME_1", "LOG_GROUP_NAME_2" ], "RetentionDays": "90" }, "Region": "REGION" } ``` 1. Output the JSON template for CreateRfc to a file in your current folder; this example names it ModifyLogRetentionRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > ModifyLogRetentionRfc.json ``` 1. Modify and save the ModifyLogRetentionRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0vfx8rwd1mcnn", "Title": "Modify CloudWatch Log Retention" } ``` 1. Create the RFC, specifying the ModifyLogRetentionRfc file and the execution parameters file: ``` aws amscm create-rfc --cli-input-json file://ModifyLogRetentionRfc.json --execution-parameters file://validateModifyLogRetention.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips To learn more about CloudWatch, see [Enable or disable detailed monitoring for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch-new.html). ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-0vfx8rwd1mcnn](schemas.md#ct-0vfx8rwd1mcnn-schema-section). ## Example: Required Parameters ``` { "DocumentName": "AWSManagedServices-ModifyCloudWatchLogRetentionPeriod", "Region": "us-east-1", "Parameters": { "LogGroupNames": [ "my-log-group" ], "RetentionDays": "90" } } ``` ## Example: All Parameters ``` Example not available. ``` # GuardDuty IP Set \$1 Delete (Managed Automation) Use to delete an Amazon GuardDuty IPSet instance which is a list of trusted IP addresses that have been whitelisted for highly secure communication with your AWS environment. **Full classification:** Management \$1 Monitoring and notification \$1 GuardDuty IP set \$1 Delete (managed automation) ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-1b8fudnqq7m8r | | Current version | 1.0 | | Expected execution duration | 240 minutes | | AWS approval | Required | | Customer approval | Not required if submitter | | Execution mode | Manual | ## Additional Information ### Delete GuardDuty IP set (Managed Automation) #### Deleting an IP set for GuardDuty (Managed Automation) with the console The following shows this change type in the AMS console. ![\[alt text not found\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiGuardDutyIpSetDeleteRrCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Deleting an IP set for GuardDuty (Managed Automation) with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-1b8fudnqq7m8r" --change-type-version "1.0" --title "Delete Amazon GuardDuty IP Set" --execution-parameters "{\"DetectorId\": \"00000000000000000000000000000000\", \"IpSetId\": \"00000000000000000000000000000000\", \"Region\": \"us-east-1\"}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteGdIpSetParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-08avsj2e9mc7g" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteGdIpSetParams.json ``` 1. Modify and save the DeleteGdIpSetParams file. For example, you can replace the contents with something like this: ``` { "DetectorId": "00000000000000000000000000000000", "IpSetId": "00000000000000000000000000000000", "Region": "us-east-1" } ``` 1. Output the RFC template JSON file to a file named DeleteGdIpSetRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > DeleteGdIpSetRfc.json ``` 1. Modify and save the DeleteGdIpSetRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-08avsj2e9mc7g", "Title": "DELETE_GD_IP_SET" } ``` 1. Create the RFC, specifying the DeleteGdIpSetRfc Rfc file and the DeleteGdIpSetParams file: ``` aws amscm create-rfc --cli-input-json file://DeleteGdIpSetRfc.json --execution-parameters file://DeleteGdIpSetParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips For more information about Amazon GuardDuty, see [Amazon Guard​Duty](https://aws.amazon.com/guardduty/). This is a manual change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a manual change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-1b8fudnqq7m8r](schemas.md#ct-1b8fudnqq7m8r-schema-section). ## Example: Required Parameters ``` { "IpSetId": "0cb0141ab9fbde177613ab9436212e90", "Region": "us-east-1" } ``` ## Example: All Parameters ``` { "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "IpSetId": "0cb0141ab9fbde177613ab9436212e90", "Region": "us-east-1", "Priority": "Medium" } ``` # GuardDuty IP Set \$1 Update (Managed Automation) Use to update an Amazon GuardDuty IPSet instance which is a list of trusted IP addresses that have been whitelisted for highly secure communication with your AWS environment. **Full classification:** Management \$1 Monitoring and notification \$1 GuardDuty IP set \$1 Update (managed automation) ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-07jzw8bzd2on7 | | Current version | 1.0 | | Expected execution duration | 240 minutes | | AWS approval | Required | | Customer approval | Not required if submitter | | Execution mode | Manual | ## Additional Information ### Update GuardDuty IP set (Managed Automation) #### Updating an IP set for GuardDuty (Managed Automation) with the console The following shows this change type in the AMS console. ![\[alt text not found\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiGuardDutyIpSetUpdateRrCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Updating an IP set for GuardDuty (Managed Automation) with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-07jzw8bzd2on7" --change-type-version "1.0" --title "Update Amazon GuardDuty IP Set" --execution-parameters "{\"Activate\": true, \"DetectorId\": \"00000000000000000000000000000000\", \"Name\": \"trusted-ips\", \"IpSet\": \"https://s3.us-west-2.amazonaws.com/bucket-name/my-object-key\", \"IpSetId\": \"00000000000000000000000000000000\", \"Region\": \"us-east-1\"}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateGdIpSetParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-07jzw8bzd2on7" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateGdIpSetParams.json ``` 1. Modify and save the UpdateGdIpSetParams file. For example, you can replace the contents with something like this: ``` { "Activate": true, "DetectorId": "00000000000000000000000000000000", "Name": "trusted-ips", "IpSet": "https://s3.us-west-2.amazonaws.com/bucket-name/my-object-key", "IpSetId": "00000000000000000000000000000000", "Region": "us-east-1" } ``` 1. Output the RFC template JSON file to a file named UpdateGdIpSetRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > UpdateGdIpSetRfc.json ``` 1. Modify and save the UpdateGdIpSetRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-07jzw8bzd2on7", "Title": "UPDATE_GD_IP_SET" } ``` 1. Create the RFC, specifying the UpdateGdIpSet Rfc file and the UpdateGdIpSetParams file: ``` aws amscm create-rfc --cli-input-json file://UpdateGdIpSetRfc.json --execution-parameters file://UpdateGdIpSetParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips This is a manual change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a manual change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. For more information about Amazon GuardDuty and creating IP sets, see [Amazon Guard​Duty](https://aws.amazon.com/guardduty/) and [CreateIPSet](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateIPSet.html). ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-07jzw8bzd2on7](schemas.md#ct-07jzw8bzd2on7-schema-section). ## Example: Required Parameters ``` { "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "IpSetId": "0cb0141ab9fbde177613ab9436212e90", "Region": "us-east-1" } ``` ## Example: All Parameters ``` { "Activate": true, "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "IpSet": "https://s3.amazonaws.com/guarddutylists/sample.txt", "IpSetId": "0cb0141ab9fbde177613ab9436212e90", "Name": "Sample IPSet", "Region": "us-east-1", "Priority": "Medium" } ``` # GuardDuty Suppression Rules \$1 Create (Managed Automation) Creation of GuardDuty Suppression Rules. **Full classification:** Management \$1 Monitoring and notification \$1 GuardDuty suppression rules \$1 Create (managed automation) ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-26swglg6rodzt | | Current version | 1.0 | | Expected execution duration | 240 minutes | | AWS approval | Required | | Customer approval | Not required if submitter | | Execution mode | Manual | ## Additional Information ### Create GuardDuty Suppression Rules (Managed Automation) #### Creating GuardDuty Suppression Rules (Managed Automation) with the console The following shows this change type in the AMS console. ![\[alt text not found\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiGuardDutySuppRulesCreateMaCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Creating GuardDuty Suppression Rules (Managed Automation) with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-26swglg6rodzt" --change-type-version "1.0" --title "Create GuardDuty suppression rules" --execution-parameters "{\"Region\":\"us-east-1\",\"Source\":[\"10.0.0.0\",\"i-1234567890abcdef0\"],\"Destination\":[\"203.0.113.1\",\"22\"],\"FindingType\":\"EC2/NetworkPortUnusual\",\"AdditonalSuppressionParameters\":\"TCP protocol\",\"Reason\":\"Reason for supressing this GuardDuty finding\",\"SuppressionRuleName\":\"TestSupressionRule\",\"Description\":\"Testing\",\"Priority\":\"High\"}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file; this example names it GuardDutySupressionRulesParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-26swglg6rodzt" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > GuardDutySupressionRulesParams.json ``` 1. Modify and save the GuardDutySupressionRulesParams file. For example, you can replace the contents with something like this: ``` { "Region": "us-east-1", "Source": [ "10.0.0.0", "i-1234567890abcdef0" ], "Destination": [ "203.0.113.1", "22" ], "FindingType": "EC2/NetworkPortUnusual", "AdditonalSuppressionParameters": "TCP protocol", "Reason": "Reason for supressing this GuardDuty finding", "SuppressionRuleName": "TestSupressionRule", "Description": "Testing", "Priority": "High" } ``` 1. Output the RFC template JSON file to a file named GuardDutySupressionRulesRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > GuardDutySupressionRulesRfc.json ``` 1. Modify and save the GuardDutySupressionRulesRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-26swglg6rodzt", "Title": "Create GuardDuty suppression rules" } ``` 1. Create the RFC, specifying the GuardDutySupressionRulesRfc file and the GuardDutySupressionRulesParams file: ``` aws amscm create-rfc --cli-input-json file://GuardDutySupressionRulesRfc.json --execution-parameters file://GuardDutySupressionRulesParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips This is a manual change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a manual change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-26swglg6rodzt](schemas.md#ct-26swglg6rodzt-schema-section). ## Example: Required Parameters ``` Example not available. ``` ## Example: All Parameters ``` Example not available. ``` # GuardDuty Threat Intel Set \$1 Delete (Managed Automation) Use to delete an Amazon GuardDuty ThreatIntelSet instance which is a list of known malicious IP addresses. **Full classification:** Management \$1 Monitoring and notification \$1 GuardDuty threat intel set \$1 Delete (managed automation) ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-2qjqju7h67s7w | | Current version | 1.0 | | Expected execution duration | 240 minutes | | AWS approval | Required | | Customer approval | Not required if submitter | | Execution mode | Manual | ## Additional Information ### Delete GuardDuty Threat intel set (Managed Automation) #### Deleting a Threat intel set for GuardDuty (Managed Automation) with the console The following shows this change type in the AMS console. ![\[alt text not found\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiGuardDutyThreatIntelSetDeleteRrCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Deleting a Threat intel set for GuardDuty (Managed Automation) with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-2qjqju7h67s7w" --change-type-version "1.0" --title "Delete Amazon GuardDuty Threat Intel Set" --execution-parameters "{\"DetectorId\": \"00000000000000000000000000000000\", \"ThreatIntelSetId\": \"00000000000000000000000000000000\", \"Region\": \"us-east-1\"}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file; this example names it DeleteGdThreatIntelSetParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-2qjqju7h67s7w" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > DeleteGdThreatIntelSetParams.json ``` 1. Modify and save the DeleteGdThreatIntelSetParams file. For example, you can replace the contents with something like this: ``` { "DetectorId": "00000000000000000000000000000000", "ThreatIntelSetId": "00000000000000000000000000000000", "Region": "us-east-1" } ``` 1. Output the RFC template JSON file to a file named DeleteGdThreatIntelSetRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > DeleteGdThreatIntelSetRfc.json ``` 1. Modify and save the DeleteGdThreatIntelSetRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2qjqju7h67s7w", "Title": "DELETE_GD_THREAT_INTEL_SET" } ``` 1. Create the RFC, specifying the DeleteGdThreatIntelSet Rfc file and the DeleteGdThreatIntelSetParams file: ``` aws amscm create-rfc --cli-input-json file://DeleteGdThreatIntelSetRfc.json --execution-parameters file://DeleteGdThreatIntelSetParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips This is a manual change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a manual change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. For more information about Amazon GuardDuty and Threat Intel sets, see [Amazon Guard​Duty](https://aws.amazon.com/guardduty/). ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-2qjqju7h67s7w](schemas.md#ct-2qjqju7h67s7w-schema-section). ## Example: Required Parameters ``` { "Region": "us-east-1", "ThreatIntelSetId": "0cb0141ab9fbde177613ab9436212e90" } ``` ## Example: All Parameters ``` { "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "Region": "us-east-1", "ThreatIntelSetId": "0cb0141ab9fbde177613ab9436212e90", "Priority": "Medium" } ``` # GuardDuty Threat Intel Set \$1 Update (Managed Automation) Use to update an Amazon GuardDuty ThreatIntelSet instance which is a list of trusted IP addresses that have been whitelisted for highly secure communication with your AWS environment. **Full classification:** Management \$1 Monitoring and notification \$1 GuardDuty threat intel set \$1 Update (managed automation) ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-2rnjx5yd6jgpt | | Current version | 1.0 | | Expected execution duration | 240 minutes | | AWS approval | Required | | Customer approval | Not required if submitter | | Execution mode | Manual | ## Additional Information ### Update GuardDuty Threat intel set (Managed Automation) #### Updating a Threat intel set for GuardDuty (Managed Automation) with the console THh following shows this change type in the AMS console. ![\[alt text not found\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiGuardDutyThreatIntelSetUpdateRrCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Updating a Threat intel set for GuardDuty (Managed Automation) with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-2rnjx5yd6jgpt" --change-type-version "1.0" --title "Update Amazon GuardDuty Threat Intel Set" --execution-parameters "{\"Activate\": true, \"DetectorId\": \"00000000000000000000000000000000\", \"Name\": \"blacklisted-ips\", \"ThreatIntelSet\": \"https://s3.us-west-2.amazonaws.com/bucket-name/my-object-key\", \"ThreatIntelSetId\": \"00000000000000000000000000000000\", \"Region\": \"us-east-1\"}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateGdThreatIntelSetParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-2rnjx5yd6jgpt" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateGdThreatIntelSetParams.json ``` 1. Modify and save the UpdateGdThreatIntelSetParams file. For example, you can replace the contents with something like this: ``` { "Activate": true, "DetectorId": "00000000000000000000000000000000", "Name": "blacklisted-ips", "ThreatIntelSet": "https://s3.us-west-2.amazonaws.com/bucket-name/my-object-key", "ThreatIntelSetId": "00000000000000000000000000000000", "Region": "us-east-1" } ``` 1. Output the RFC template JSON file to a file named UpdateGdThreatIntelSetRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > UpdateGdThreatIntelSetRfc.json ``` 1. Modify and save the UpdateGdThreatIntelSetRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-2rnjx5yd6jgpt", "Title": "CREATE_GD_IP_SET" } ``` 1. Create the RFC, specifying the UpdateGdThreatIntelSet Rfc file and the UpdateGdThreatIntelSetParams file: ``` aws amscm create-rfc --cli-input-json file://UpdateGdThreatIntelSetRfc.json --execution-parameters file://UpdateGdThreatIntelSetParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips This is a manual change type (an AMS operator must review and run the CT), which means that the RFC can take longer to run and you might have to communicate with AMS through the RFC details page correspondance option. Additionally, if you schedule a manual change type RFC, be sure to allow at least 24 hours, if approval does not happen before the scheduled start time, the RFC is rejected automatically. For more information about Amazon GuardDuty and creating Threat Intel sets, see [Amazon Guard​Duty](https://aws.amazon.com/guardduty/) and [CreateThreatIntelSet](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateThreatIntelSet.html). ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-2rnjx5yd6jgpt](schemas.md#ct-2rnjx5yd6jgpt-schema-section). ## Example: Required Parameters ``` { "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "ThreatIntelSetId": "0cb0141ab9fbde177613ab9436212e90", "Region": "us-east-1" } ``` ## Example: All Parameters ``` { "Activate": true, "DetectorId": "12abc34d567e8fa901bc2d34e56789f0", "ThreatIntelSet": "https://s3.amazonaws.com/guarddutylists/sample.txt", "ThreatIntelSetId": "0cb0141ab9fbde177613ab9436212e90", "Name": "Sample ThreatIntelSet", "Region": "us-east-1", "Priority": "Medium" } ``` # SNS \$1 Subscribe To DirectCustomerAlerts Subscribe an email address to the Direct-Customer-Alerts SNS topic. **Full classification:** Management \$1 Monitoring and notification \$1 SNS \$1 Subscribe to DirectCustomerAlerts ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-3rcl9u1k017wu | | Current version | 1.0 | | Expected execution duration | 10 minutes | | AWS approval | Required | | Customer approval | Not required | | Execution mode | Automated | ## Additional Information ### Subscribe to SNS DirectCustomerAlerts #### Subscribing to the Direct-Customer-Alerts SNS topic with the Console Screenshot of this change type in the AMS console: ![\[Subscribe to DirectCustomerAlerts form with description, ID, and version fields.\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiSnsSubscribeAlertsCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Subscribing to the Direct-Customer-Alerts SNS topic with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*:? Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-3rcl9u1k017wu" --change-type-version "1.0" --title "Subscribe-Direct-Customer-Alerts" --execution-parameters "{\"Email\": \"sample-email@example.com\", \"Region\": \"us-east-1\"}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file; this example names it SnsSubscribeParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-3rcl9u1k017wu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > SnsSubscribeParams.json ``` 1. Modify and save the SnsSubscribeParams file. For example, you can replace the contents with something like this: ``` { "Description": "SnsTopicSub-Create", "VpcId": "VPC_ID", "Name": "My-SnsTopicSub", "Parameters":{ "TopicName": "mytopic-cli-all-params", "DisplayName": "testsns", "Subscription1Protocol": "email", "Subscription1Endpoint": "abc@xyz.com", "Subscription1RawMessageDelivery": "false", "Subscription2Protocol": "sms", "Subscription2Endpoint": "+61500444777", "Subscription2RawMessageDelivery": "false", "KmsMasterKeyId": "arn:aws:kms:us-east-1:123456789101:key/cfe0542d-3be9-4166-9eac-d0cd6af61445" } } ``` 1. Output the RFC template JSON file to a file named SnsSubscribeRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > SnsSubscribeRfc.json ``` 1. Modify and save the SnsSubscribeRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-3rcl9u1k017wu", "Title": "Subscribe-Direct-Customer-Alerts-RFC" } ``` 1. Create the RFC, specifying the SnsSubscribe Rfc file and the SnsSubscribeParams file: ``` aws amscm create-rfc --cli-input-json file://SnsSubscribeRfc.json --execution-parameters file://SnsSubscribeParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips To learn more about AWS Simple Notification Service (SNS), see [Amazon Simple Notification Service](https://aws.amazon.com/sns/). Also see [Getting Started with Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html). ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-3rcl9u1k017wu](schemas.md#ct-3rcl9u1k017wu-schema-section). ## Example: Required Parameters ``` Example not available. ``` ## Example: All Parameters ``` Example not available. ``` # SNS \$1 Update (Managed Automation) Modify the properties of an existing Amazon Simple Notification Service (SNS) topic. **Full classification:** Management \$1 Monitoring and notification \$1 SNS \$1 Update (managed automation) ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-0zzf0fjz76jmb | | Current version | 1.0 | | Expected execution duration | 240 minutes | | AWS approval | Required | | Customer approval | Not required if submitter | | Execution mode | Manual | ## Additional Information ### Update SNS topic #### Update SNS topic with the Console Screenshot of this change type in the AMS console: ![\[alt text not found\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiSnsUpdateCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Update SNS topic with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE* (minimal parameters): Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-0zzf0fjz76jmb" --change-type-version "1.0" --title "Update SNS Topic" --execution-parameters "{\"TopicArn\": \"arn:aws:sns:us-east-1:123456789101:My-SNS-Topic\", \"Priority\": \"Medium\", \"Parameters\": {\"DisplayName\": \"My-SNS-Topic\", \"KmsMasterKeyId\": \"arn:aws:kms:us-east-1:123456789101:key/cfe0542d-3be9-4166-9eac-d0cd6af61445\"}}" ``` *TEMPLATE CREATE* (all parameters): 1. Output the execution parameters JSON schema for this change type to a file; this example names it SnsUpdateParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-3rcl9u1k017wu" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > SnsUpdateParams.json ``` 1. Modify and save the SnsUpdateParams file. For example, you can replace the contents with something like this: ``` { "TopicArn": "arn:aws:sns:us-east-1:123456789101:Test-Stack", "Parameters": { "DisplayName": "My-Test-Stack", "DeliveryPolicy": "{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0,\"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false,\"defaultRequestPolicy\":{\"headerContentType\":\"text/plain; charset=UTF-8\"}}}", "DataProtectionPolicy": "{\"Name\":\"__example_data_protection_policy\",\"Description\":\"Exampledataprotectionpolicy\",\"Version\":\"2021-06-01\",\"Statement\":[{\"DataDirection\":\"Inbound\",\"Principal\":[\"arn:aws:iam::123456789101:user/ExampleUser\"],\"DataIdentifier\":[\"arn:aws:dataprotection::aws:data-identifier/CreditCardNumber\"],\"Operation\":{\"Deidentify\":{\"MaskConfig\":{\"MaskWithCharacter\":\"#\"}}}}]}", "KmsMasterKeyARN": "arn:aws:kms:ap-southeast-2:123456789101:key/bb43bd18-3a75-482e-822d-d0d3a5544dc8", "TracingConfig": "Active" }, "Priority": "Medium" } ``` 1. Output the RFC template JSON file to a file named SnsUpdateRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > SnsUpdateRfc.json ``` 1. Modify and save the SnsUpdateRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0zzf0fjz76jmb", "Title": "Update-SNS-RFC" } ``` 1. Create the RFC, specifying the SnsUpdate Rfc file and the SnsUpdateParams file: ``` aws amscm create-rfc --cli-input-json file://SnsUpdateRfc.json --execution-parameters file://SnsUpdateParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips To learn more about AWS Simple Notification Service (SNS), see [Amazon Simple Notification Service](https://aws.amazon.com/sns/). Also see [Getting Started with Amazon SNS](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html). ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-0zzf0fjz76jmb](schemas.md#ct-0zzf0fjz76jmb-schema-section). ## Example: Required Parameters ``` { "TopicArn": "arn:aws:sns:us-east-1:000000000000:Test-Stack" } ``` ## Example: All Parameters ``` { "TopicArn": "arn:aws:sns:us-east-1:000000000000:Test-Stack", "Parameters":{ "DisplayName": "Test-Stack", "AddSubscriptions": [ { "Protocol": "http", "Endpoint": "http://example.com/webhook" }, { "Protocol": "https", "Endpoint": "https://example.com/webhook" }, { "Protocol": "email", "Endpoint": "test@example.com" }, { "Protocol": "email-json", "Endpoint": "test@example.com" }, { "Protocol": "sms", "Endpoint": "+1234567890" }, { "Protocol": "sqs", "Endpoint": "arn:aws:sqs:us-east-1:000000000000:TestQueue" }, { "Protocol": "application", "Endpoint": "arn:aws:sns:us-east-1:000000000000:endpoint/GCM/MyApplication" }, { "Protocol": "lambda", "Endpoint": "arn:aws:lambda:us-east-1:000000000000:function:TestFunction" }, { "Protocol": "firehose", "Endpoint": "arn:aws:firehose:us-east-1:000000000000:deliverystream/TestStream" } ], "RemoveSubscriptions": [ "arn:aws:sns:us-east-1:000000000000:Test-Stack:12345678-1234-1234-1234-123456789012" ], "DeliveryPolicy": "{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0,\"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false,\"defaultRequestPolicy\":{\"headerContentType\":\"text/plain; charset=UTF-8\"}}}", "DataProtectionPolicy": "{\"Name\":\"__example_data_protection_policy\",\"Description\":\"Exampledataprotectionpolicy\",\"Version\":\"2021-06-01\",\"Statement\":[{\"DataDirection\":\"Inbound\",\"Principal\":[\"arn:aws:iam::123456789012:user/ExampleUser\"],\"DataIdentifier\":[\"arn:aws:dataprotection::aws:data-identifier/CreditCardNumber\"],\"Operation\":{\"Deidentify\":{\"MaskConfig\":{\"MaskWithCharacter\":\"#\"}}}}]}", "KmsMasterKeyARN": "arn:aws:kms:ap-southeast-2:123456789023:key/bb43bd18-3a75-482e-822d-d0d3a5544dc8", "TracingConfig": "Active" }, "Priority": "Medium" } ``` # SQS \$1 Update Use to modify the properties of an existing Amazon Simple Queue Service instance. **Full classification:** Management \$1 Monitoring and notification \$1 SQS \$1 Update ## Change Type Details **** | | | | --- |--- | | Change type ID | ct-0hi7z7tyikjf6 | | Current version | 1.0 | | Expected execution duration | 60 minutes | | AWS approval | Required | | Customer approval | Not required | | Execution mode | Automated | ## Additional Information ### Update SQS queue #### Updating an SQS queue with the Console Screenshot of this change type in the AMS console: ![\[Properties panel for an Amazon Simple Queue Service instance, showing ID, version, and execution mode.\]](http://docs.aws.amazon.com/managedservices/latest/ctref/images/guiSqsUpdateCT.png) How it works: 1. Navigate to the **Create RFC** page: In the left navigation pane of the AMS console click **RFCs** to open the RFCs list page, and then click **Create RFC**. 1. Choose a popular change type (CT) in the default **Browse change types** view, or select a CT in the **Choose by category** view. + **Browse by change type**: You can click on a popular CT in the **Quick create** area to immediately open the **Run RFC** page. Note that you cannot choose an older CT version with quick create. To sort CTs, use the **All change types** area in either the **Card** or **Table** view. In either view, select a CT and then click **Create RFC** to open the **Run RFC** page. If applicable, a **Create with older version** option appears next to the **Create RFC** button. + **Choose by category**: Select a category, subcategory, item, and operation and the CT details box opens with an option to **Create with older version** if applicable. Click **Create RFC** to open the **Run RFC** page. 1. On the **Run RFC** page, open the CT name area to see the CT details box. A **Subject** is required (this is filled in for you if you choose your CT in the **Browse change types** view). Open the **Additional configuration** area to add information about the RFC. In the **Execution configuration** area, use available drop-down lists or enter values for the required parameters. To configure optional execution parameters, open the **Additional configuration** area. 1. When finished, click **Run**. If there are no errors, the **RFC successfully created** page displays with the submitted RFC details, and the initial **Run output**. 1. Open the **Run parameters** area to see the configurations you submitted. Refresh the page to update the RFC execution status. Optionally, cancel the RFC or create a copy of it with the options at the top of the page. #### Updating an SQS queue with the CLI How it works: 1. Use either the Inline Create (you issue a `create-rfc` command with all RFC and execution parameters included), or Template Create (you create two JSON files, one for the RFC parameters and one for the execution parameters) and issue the `create-rfc` command with the two files as input. Both methods are described here. 1. Submit the RFC: `aws amscm submit-rfc --rfc-id ID` command with the returned RFC ID. Monitor the RFC: `aws amscm get-rfc --rfc-id ID` command. To check the change type version, use this command: ``` aws amscm list-change-type-version-summaries --filter Attribute=ChangeTypeId,Value=CT_ID ``` **Note** You can use any `CreateRfc` parameters with any RFC whether or not they are part of the schema for the change type. For example, to get notifications when the RFC status changes, add this line, `--notification "{\"Email\": {\"EmailRecipients\" : [\"email@example.com\"]}}"` to the RFC parameters part of the request (not the execution parameters). For a list of all CreateRfc parameters, see the [AMS Change Management API Reference](https://docs.aws.amazon.com/managedservices/latest/ApiReference-cm/API_CreateRfc.html). *INLINE CREATE*: Issue the create RFC command with execution parameters provided inline (escape quotes when providing execution parameters inline), and then submit the returned RFC ID. For example, you can replace the contents with something like this: ``` aws amscm create-rfc --change-type-id "ct-0hi7z7tyikjf6" --change-type-version "1.0" --title "Update Amazon SQS Queue" --execution-parameters "{\"VpcId\": \"VPC_ID\", \"StackId\": \"STACK_ID\", \"Parameters\": {\"SQSDelaySeconds\": 0, \"SQSMaximumMessageSize\": 262144, \"SQSMessageRetentionPeriod\": 345600, \"SQSQueueName\": \"MyQueueName\", \"SQSReceiveMessageWaitTimeSeconds\": 0, \"SQSVisibilityTimeout\": 60}}" ``` *TEMPLATE CREATE*: 1. Output the execution parameters JSON schema for this change type to a file; this example names it UpdateSqsInstanceParams.json. ``` aws amscm get-change-type-version --change-type-id "ct-0hi7z7tyikjf6" --query "ChangeTypeVersion.ExecutionInputSchema" --output text > UpdateSqsInstanceParams.json ``` 1. Modify and save the UpdateSqsInstanceParams file. For example, you can replace the contents with something like this: ``` { "VpcId": "VPC_ID", "StackId": "STACK_ID", "Parameters": { "SQSDelaySeconds": 0, "SQSMaximumMessageSize": 262144, "SQSMessageRetentionPeriod": 345600, "SQSQueueName": "MyQueueName", "SQSReceiveMessageWaitTimeSeconds": 0, "SQSVisibilityTimeout": 60 } } ``` 1. Output the RFC template JSON file to a file named UpdateSqsInstanceRfc.json: ``` aws amscm create-rfc --generate-cli-skeleton > UpdateSqsInstanceRfc.json ``` 1. Modify and save the UpdateSqsInstanceRfc.json file. For example, you can replace the contents with something like this: ``` { "ChangeTypeVersion": "1.0", "ChangeTypeId": "ct-0hi7z7tyikjf6", "Title": "Sqs-Instance-Update-RFC" } ``` 1. Create the RFC, specifying the UpdateSqsTopicSub Rfc file and the UpdateSqsTopicSubParams file: ``` aws amscm create-rfc --cli-input-json file://UpdateSqsInstanceRfc.json --execution-parameters file://UpdateSqsInstanceParams.json ``` You receive the ID of the new RFC in the response and can use it to submit and monitor the RFC. Until you submit it, the RFC remains in the editing state and does not start. #### Tips To learn more about Amazon Simple Queue Service (SQS), see [Amazon Simple Queue Service](https://aws.amazon.com/sqs/). ## Execution Input Parameters For detailed information about the execution input parameters, see [Schema for Change Type ct-0hi7z7tyikjf6](schemas.md#ct-0hi7z7tyikjf6-schema-section). ## Example: Required Parameters ``` { "VpcId": "vpc-01234567890abcdef", "StackId": "stack-a1b2c3d4e5f67890e", "Parameters": { "SQSQueueName": "mytestsqs" } } ``` ## Example: All Parameters ``` { "VpcId": "vpc-12345678", "StackId": "stack-a1b2c3d4e5f67890e", "Parameters": { "SQSDelaySeconds": 0, "SQSMaximumMessageSize": 262144, "SQSMessageRetentionPeriod": 345600, "SQSQueueName": "mytestsqs", "SQSReceiveMessageWaitTimeSeconds": 0, "SQSVisibilityTimeout": 0 } } ```