AWS aws-sdk-php documentation change
Summary
Updated documentation for various SSM API operations including PutParameter, associations, Change Calendar, and resource data sync. Added clarification about ParameterNotFound exception not being recorded in CloudTrail for DeleteParameter and GetParameter actions. Enhanced descriptions of association scheduling behavior and parameter management.
Security assessment
The changes primarily focus on clarifying API behavior and improving documentation accuracy. While there is a mention of CloudTrail logging behavior, this is a documentation clarification rather than addressing a specific security vulnerability or weakness.
Diff
diff --git a/aws-sdk-php/v3/api/api-ssm-2014-11-06.md index 6480622cf..8d01ef2e4 100644 --- a/aws-sdk-php/v3/api/api-ssm-2014-11-06.md +++ b/aws-sdk-php/v3/api/api-ssm-2014-11-06.md @@ -582 +582 @@ You can also create and send a command immediately using the magic methods avail -**PutParameter** ( array $params = [] ) Add a parameter to the system. +**PutParameter** ( array $params = [] ) Create or update a parameter in Parameter Store. @@ -1304 +1304,5 @@ The details for the CloudWatch alarm you want to apply to an automation or comma -By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions. +By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified and when target changes are detected. Specify `true` for `ApplyOnlyAtCronInterval`if you want the association to run only according to the schedule you specified. + +For more information, see [Understanding when associations are applied to resources](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling) and [>About target updates with Automation runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates) in the _Amazon Web Services Systems Manager User Guide_. + +This parameter isn't supported for rate expressions. @@ -1325 +1329 @@ Choose the parameter that will define how your automation will branch out. This -The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). +The names of Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the _Amazon Web Services Systems Manager User Guide_. @@ -3770,0 +3775,2 @@ The parameter couldn't be found. Verify the name and try again. +For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is _not_ recorded in CloudTrail event logs. + @@ -4047 +4053,3 @@ No policies with the specified policy ID and hash could be found. -Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first. +Removes the server or virtual machine from the list of registered servers. + +If you want to reregister an on-premises server, edge device, or VM, you must use a different Activation Code and Activation ID than used to register the machine previously. The Activation Code and Activation ID must not have already been used on the maximum number of activations specified when they were created. For more information, see [Deregistering managed nodes in a hybrid and multicloud environment](https://docs.aws.amazon.com/systems-manager/latest/userguide/fleet-manager-deregister-hybrid-nodes.html) in the _Amazon Web Services Systems Manager User Guide_. @@ -9286 +9294 @@ For more information about Change Calendar, a tool in Amazon Web Services System -The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state. +The names of Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state. @@ -11857,0 +11866,2 @@ The parameter couldn't be found. Verify the name and try again. +For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is _not_ recorded in CloudTrail event logs. + @@ -11976,0 +11987,2 @@ The parameter couldn't be found. Verify the name and try again. +For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is _not_ recorded in CloudTrail event logs. + @@ -12807,0 +12820,2 @@ The parameter couldn't be found. Verify the name and try again. +For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is _not_ recorded in CloudTrail event logs. + @@ -14311 +14325,5 @@ The token for the next set of items to return. (You received this token from a p -The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configurations. Optional for single account/single-Region configurations. +The name of the Amazon Web Services managed resource data sync to retrieve information about. + +For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is `AWS-QuickSetup-ManagedNode`. + +For single account/single-Region configurations, the parameter is not required. @@ -14515 +14533,5 @@ The token for the next set of items to return. (You received this token from a p -The name of the resource data sync to retrieve information about. Required for cross-account/cross-Region configuration. Optional for single account/single-Region configurations. +The name of the Amazon Web Services managed resource data sync to retrieve information about. + +For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is `AWS-QuickSetup-ManagedNode`. + +For single account/single-Region configurations, the parameter is not required. @@ -15666 +15688 @@ The sub-type count exceeded the limit for the inventory type. -Add a parameter to the system. +Create or update a parameter in Parameter Store. @@ -15741 +15763 @@ The Key Management Service (KMS) ID that you want to use to encrypt a parameter. -If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account which is not as secure as using a custom key. +If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account, which is not as secure as using a custom key. @@ -15754 +15776 @@ If you don't specify a key ID, the system uses the default key associated with y -The fully qualified name of the parameter that you want to add to the system. +The fully qualified name of the parameter that you want to create or update. @@ -15873 +15895 @@ For more information about configuring the default tier option, see [Specifying -The type of parameter that you want to add to the system. +The type of parameter that you want to create. @@ -18411,0 +18434,2 @@ The parameter couldn't be found. Verify the name and try again. +For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is _not_ recorded in CloudTrail event logs. + @@ -18531 +18555,3 @@ The details for the CloudWatch alarm you want to apply to an automation or comma -By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you update it. This parameter isn't supported for rate expressions. +By default, when you update an association, the system runs it immediately after it is updated and then according to the schedule you specified. Specify `true` for `ApplyOnlyAtCronInterval` if you want the association to run only according to the schedule you specified. + +If you chose this option when you created an association and later you edit that association or you make changes to the Automation runbook or SSM document on which that association is based, State Manager applies the association at the next specified cron interval. For example, if you chose the `Latest` version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously set `ApplyOnlyAtCronInterval` to `true`. If this option wasn't selected, State Manager immediately runs the association. @@ -18533 +18559 @@ By default, when you update an association, the system runs it immediately after -If you chose this option when you created an association and later you edit that association or you make changes to the SSM document on which that association is based (by using the Documents page in the console), State Manager applies the association at the next specified cron interval. For example, if you chose the `Latest` version of an SSM document when you created an association and you edit the association by choosing a different document version on the Documents page, State Manager applies the association at the next specified cron interval if you previously selected this option. If this option wasn't selected, State Manager immediately runs the association. +For more information, see [Understanding when associations are applied to resources](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling) and [About target updates with Automation runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates) in the _Amazon Web Services Systems Manager User Guide_. @@ -18535 +18561,3 @@ If you chose this option when you created an association and later you edit that -You can reset this option. To do so, specify the `no-apply-only-at-cron-interval` parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified. +This parameter isn't supported for rate expressions. + +You can reset this parameter. To do so, specify the `no-apply-only-at-cron-interval` parameter when you update the association from the command line. This parameter forces the association to run immediately after updating it and according to the interval specified. @@ -18571 +18599 @@ Choose the parameter that will define how your automation will branch out. This -The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). +The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations under. The associations only run when that change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the _Amazon Web Services Systems Manager User Guide_. @@ -21647 +21675 @@ Choose the parameter that will define how your automation will branch out. This -The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). +The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the _Amazon Web Services Systems Manager User Guide_. @@ -22157 +22185 @@ Information about the association version. -By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions. +By default, when you create new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions. @@ -22185 +22213 @@ The association version. -The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). +The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the _Amazon Web Services Systems Manager User Guide_. @@ -24044 +24072,5 @@ The details for the CloudWatch alarm you want to apply to an automation or comma -By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter isn't supported for rate expressions. +By default, when you create a new association, the system runs it immediately after it is created and then according to the schedule you specified and when target changes are detected. Specify `true` for `ApplyOnlyAtCronInterval` if you want the association to run only according to the schedule you specified. + +For more information, see [Understanding when associations are applied to resources](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling) and [>About target updates with Automation runbooks](https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates) in the _Amazon Web Services Systems Manager User Guide_. + +This parameter isn't supported for rate expressions. @@ -24065 +24097 @@ Specify the target for the association. This target is required for associations -The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). +The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar) in the _Amazon Web Services Systems Manager User Guide_. @@ -29853,0 +29886,2 @@ The parameter couldn't be found. Verify the name and try again. +For the `DeleteParameter` and `GetParameter` actions, if the specified parameter doesn't exist, the `ParameterNotFound` exception is _not_ recorded in CloudTrail event logs. +