AWS solutions documentation change
Summary
Formatting and syntax corrections in CLI documentation, including hyphens, markdown styling, command syntax examples, and list item formatting. Updates to parameter descriptions and constraints with clearer formatting.
Security assessment
Changes focus on documentation formatting, syntax standardization, and clarification of existing content. No evidence of addressing security vulnerabilities or introducing new security features. Permission requirements remain unchanged.
Diff
diff --git a/solutions/latest/instance-scheduler-on-aws/scheduler-cli-4.md b/solutions/latest/instance-scheduler-on-aws/scheduler-cli-4.md index 097b202b5..c51cf14cf 100644 --- a/solutions/latest/instance-scheduler-on-aws/scheduler-cli-4.md +++ b/solutions/latest/instance-scheduler-on-aws/scheduler-cli-4.md @@ -21 +21 @@ Your credentials must have the following permissions: - * ` lambda:InvokeFunction` – To invoke the InstanceSchedulerMain function in the scheduler stack, and to update the schedule and period information in the scheduler configuration database from the command line + * `lambda:InvokeFunction` \- To invoke the InstanceSchedulerMain function in the scheduler stack, and to update the schedule and period information in the scheduler configuration database from the command line @@ -23 +23 @@ Your credentials must have the following permissions: - * `cloudformation:DescribeStackResource `– To retrieve the physical resource ID of the AWS Lambda function from the stack to handle the CLI request + * `cloudformation:DescribeStackResource` \- To retrieve the physical resource ID of the AWS Lambda function from the stack to handle the CLI request @@ -36 +36 @@ If you specify a profile using the profile-name argument, the profile you specif - 1. [Download](https://s3.amazonaws.com/solutions-reference/instance-scheduler-on-aws/latest/instance_scheduler_cli.zip) the scheduler CLI package _(_****instance_scheduler_cli.zip**** _)_ and place it in a directory on your computer. + 1. [Download](https://s3.amazonaws.com/solutions-reference/instance-scheduler-on-aws/latest/instance_scheduler_cli.zip) the scheduler CLI package **_(instance_scheduler_cli.zip)_ ** and place it in a directory on your computer. @@ -40 +40 @@ If you specify a profile using the profile-name argument, the profile you specif -The installation will fail if you don't place the files into their own directory, and then install them from that directory. +The installation will fail if you don’t place the files into their own directory, and then install them from that directory. @@ -48 +48 @@ The installation will fail if you don't place the files into their own directory -Scheduler-CLI requires Python 3.8 or above and the latest versions of pip and boto3. If you do not have all of these installed on your local machine, please refer to [pip's official documentation](https://pip.pypa.io/en/stable/getting-started/) for installation instructions before attempting to install the Scheduler-CLI. +Scheduler-CLI requires Python 3.8 or above and the latest versions of pip and boto3. If you do not have all of these installed on your local machine, please refer to [pip’s official documentation](https://pip.pypa.io/en/stable/getting-started/) for installation instructions before attempting to install the Scheduler-CLI. @@ -54 +54 @@ Scheduler-CLI requires Python 3.8 or above and the latest versions of pip and bo - scheduler-cli –-help + scheduler-cli --help @@ -76,3 +76,3 @@ Argument | Description -`--stack `<stackname>`` | The name of the scheduler stack. **Important:** This argument is required for all commands. -`--region `<regionname>`` | The name of the region where the scheduler stack is deployed. **Note:** You must use this argument when the default configuration and credential files are not installed in the same region as the solution stack. -`--profile-name `<profilename>`` | The name of the profile to use to run commands. If no profile name is specified, the default profile is used. +`--stack [replaceable]<stackname>` | The name of the scheduler stack. **Important:** This argument is required for all commands. +`--region [replaceable]<regionname>` | The name of the region where the scheduler stack is deployed. **Note:** You must use this argument when the default configuration and credential files are not installed in the same region as the solution stack. +`--profile-name [replaceable] <profilename>` | The name of the profile to use to run commands. If no profile name is specified, the default profile is used. @@ -119 +119 @@ Creates a period. A period must contain at least one of the following items: `be -The name of the period + * The name of the period @@ -128 +131 @@ Required: Yes -A description of the period + * A description of the period @@ -137 +143 @@ Required: No -The time when the running period starts. If `begintime` and `endtime` are not specified, the running period is 00:00 – 23:59. + * The time when the running period starts. If `begintime` and `endtime` are not specified, the running period is 00:00 - 23:59. @@ -148 +157 @@ Required: No -The time when the running period stops. If `begintime` and `endtime` are not specified, the running period is 00:00 – 23:59. + * The time when the running period stops. If `begintime` and `endtime` are not specified, the running period is 00:00 - 23:59. @@ -159 +171 @@ Required: No -The days of the week for the period + * The days of the week for the period @@ -163 +175 @@ Type: String -Constraints: Comma-delimited list of abbreviated day names (mon) or numbers (0). Use – to specify a range. Use / to specify every nth day of the week. +Constraints: Comma-delimited list of abbreviated day names (mon) or numbers (0). Use - to specify a range. Use / to specify every n^th^ day of the week. @@ -170 +185 @@ Required: No -The months of the period + * The months of the period @@ -174 +189 @@ Type: String -Constraints: Comma-delimited list of abbreviated months names (jan) or numbers (1). Use – to specify a range. Use / to specify every nth month. +Constraints: Comma-delimited list of abbreviated months names (jan) or numbers (1). Use - to specify a range. Use / to specify every n^th^ month. @@ -181 +199 @@ Required: No -The days of the month for the period + * The days of the month for the period @@ -185 +203 @@ Type: String -Constraints: Comma-delimited list of abbreviated months names (jan) or numbers (1). Use – to specify a range. Use / to specify every nth day of the month. +Constraints: Comma-delimited list of abbreviated months names (jan) or numbers (1). Use - to specify a range. Use / to specify every n^th^ day of the month. @@ -217 +237 @@ Creates a schedule. -The name of the schedule + * The name of the schedule @@ -226 +249 @@ Required: Yes -A description of the schedule + * A description of the schedule @@ -235 +261 @@ Required: No -Enforces the scheduled state for the instance + * Enforces the scheduled state for the instance @@ -242 +271 @@ Required: No -Collect Amazon CloudWatch metrics + * Collect Amazon CloudWatch metrics @@ -249 +281 @@ Required: No -A list of running periods for the schedule. If multiple periods are specified, the solution will start an instance if one of the periods evaluates to `true`. + * A list of running periods for the schedule. If multiple periods are specified, the solution will start an instance if one of the periods evaluates to `true`. @@ -253 +285 @@ Type: String -Constraints: Comma-delimited list of periods. Use `<period-name>@`<instance type>`` to specify an instance type for a period. For example, `[email protected]`. +Constraints: Comma-delimited list of periods. Use `<period-name>@[replaceable]<instance type>` to specify an instance type for a period. For example, `[email protected]`. @@ -260 +295 @@ Required: Yes -Prevents an instance from being stopped by the solution at the end of a running period, if the instance was manually started before the beginning of the period. + * Prevents an instance from being stopped by the solution at the end of a running period, if the instance was manually started before the beginning of the period. @@ -267 +305 @@ Required: No -Adds an AWS Systems Manager maintenance window as a running period to an Amazon EC2 instance schedule. To use this command, you must use the `use-maintenance-window` command. + * Adds an AWS Systems Manager maintenance window as a running period to an Amazon EC2 instance schedule. To use this command, you must use the `use-maintenance-window` command. @@ -276 +317 @@ Required: No -Do not stop an instance the first time it is tagged if it is running outside of a running period + * Do not stop an instance the first time it is tagged if it is running outside of a running period @@ -283 +327 @@ Required: No -The time zone the schedule will use + * The time zone the schedule will use @@ -292 +339 @@ Required: No (If this argument is not used, the default time zone from main solu -Adds an Amazon RDS maintenance window as a running period to an Amazon RDS instance schedule, or an AWS Systems Manager maintenance window as a running period to an Amazon EC2 instance schedule + * Adds an Amazon RDS maintenance window as a running period to an Amazon RDS instance schedule, or an AWS Systems Manager maintenance window as a running period to an Amazon EC2 instance schedule @@ -319 +369 @@ Required: No -The name of the applicable period + * The name of the applicable period @@ -348 +401 @@ Deletes an existing schedule -The name of the applicable schedule + * The name of the applicable schedule @@ -373 +429 @@ Lists the configured periods for the Instance Scheduler stack -The name of a specific period you want described + * The name of a specific period you want described @@ -438 +497 @@ Lists the configured schedules for the Instance Scheduler stack. -The name of a specific schedule you want described + * The name of a specific schedule you want described @@ -494 +556 @@ Lists all the periods running within a schedule and calculates the billing hours -The name of the applicable schedule + * The name of the applicable schedule @@ -503 +568 @@ Required: Yes -The start date of the period used for calculation. The default date is the current date. + * The start date of the period used for calculation. The default date is the current date. @@ -512 +580 @@ Required: No -The end date of the period used for calculation. The default date is the current date. + * The end date of the period used for calculation. The default date is the current date.