Skip to content

Commit 08b5479

Browse files
author
awstools
committed
docs(client-ssm): Systems Manager doc-only updates for Feb. 2025.
1 parent 15f7c5a commit 08b5479

11 files changed

+112
-63
lines changed

‎clients/client-ssm/src/commands/DeleteParameterCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ export interface DeleteParameterCommandOutput extends DeleteParameterResult, __M
5656
*
5757
* @throws {@link ParameterNotFound} (client fault)
5858
* <p>The parameter couldn't be found. Verify the name and try again.</p>
59+
* <note>
60+
* <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the
61+
* specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is
62+
* <i>not</i> recorded in CloudTrail event logs.</p>
63+
* </note>
5964
*
6065
* @throws {@link SSMServiceException}
6166
* <p>Base exception class for all service exceptions from SSM service.</p>

‎clients/client-ssm/src/commands/DeregisterManagedInstanceCommand.ts

+7-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,13 @@ export interface DeregisterManagedInstanceCommandInput extends DeregisterManaged
2828
export interface DeregisterManagedInstanceCommandOutput extends DeregisterManagedInstanceResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Removes the server or virtual machine from the list of registered servers. You can
32-
* reregister the node again at any time. If you don't plan to use Run Command on the server, we
33-
* suggest uninstalling SSM Agent first.</p>
31+
* <p>Removes the server or virtual machine from the list of registered servers.</p>
32+
* <p>If you want to reregister an on-premises server, edge device, or VM, you must use a
33+
* different Activation Code and Activation ID than used to register the machine previously. The
34+
* Activation Code and Activation ID must not have already been used on the maximum number of
35+
* activations specified when they were created. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/fleet-manager-deregister-hybrid-nodes.html">Deregistering
36+
* managed nodes in a hybrid and multicloud environment</a> in the
37+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3438
* @example
3539
* Use a bare-bones client and the command you need to make an API call.
3640
* ```javascript

‎clients/client-ssm/src/commands/GetParameterCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ export interface GetParameterCommandOutput extends GetParameterResult, __Metadat
7474
*
7575
* @throws {@link ParameterNotFound} (client fault)
7676
* <p>The parameter couldn't be found. Verify the name and try again.</p>
77+
* <note>
78+
* <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the
79+
* specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is
80+
* <i>not</i> recorded in CloudTrail event logs.</p>
81+
* </note>
7782
*
7883
* @throws {@link ParameterVersionNotFound} (client fault)
7984
* <p>The specified parameter version wasn't found. Verify the parameter name and version, and try

‎clients/client-ssm/src/commands/GetParameterHistoryCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ export interface GetParameterHistoryCommandOutput extends GetParameterHistoryRes
101101
*
102102
* @throws {@link ParameterNotFound} (client fault)
103103
* <p>The parameter couldn't be found. Verify the name and try again.</p>
104+
* <note>
105+
* <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the
106+
* specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is
107+
* <i>not</i> recorded in CloudTrail event logs.</p>
108+
* </note>
104109
*
105110
* @throws {@link SSMServiceException}
106111
* <p>Base exception class for all service exceptions from SSM service.</p>

‎clients/client-ssm/src/commands/LabelParameterVersionCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,11 @@ export interface LabelParameterVersionCommandOutput extends LabelParameterVersio
100100
*
101101
* @throws {@link ParameterNotFound} (client fault)
102102
* <p>The parameter couldn't be found. Verify the name and try again.</p>
103+
* <note>
104+
* <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the
105+
* specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is
106+
* <i>not</i> recorded in CloudTrail event logs.</p>
107+
* </note>
103108
*
104109
* @throws {@link ParameterVersionLabelLimitExceeded} (client fault)
105110
* <p>A parameter version can have a maximum of ten labels.</p>

‎clients/client-ssm/src/commands/PutParameterCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface PutParameterCommandInput extends PutParameterRequest {}
2828
export interface PutParameterCommandOutput extends PutParameterResult, __MetadataBearer {}
2929

3030
/**
31-
* <p>Add a parameter to the system.</p>
31+
* <p>Create or update a parameter in Parameter Store.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

‎clients/client-ssm/src/commands/UnlabelParameterVersionCommand.ts

+5
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ export interface UnlabelParameterVersionCommandOutput extends UnlabelParameterVe
6666
*
6767
* @throws {@link ParameterNotFound} (client fault)
6868
* <p>The parameter couldn't be found. Verify the name and try again.</p>
69+
* <note>
70+
* <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the
71+
* specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is
72+
* <i>not</i> recorded in CloudTrail event logs.</p>
73+
* </note>
6974
*
7075
* @throws {@link ParameterVersionNotFound} (client fault)
7176
* <p>The specified parameter version wasn't found. Verify the parameter name and version, and try

‎clients/client-ssm/src/models/models_0.ts

+24-11
Original file line numberDiff line numberDiff line change
@@ -1346,18 +1346,22 @@ export interface CreateAssociationRequest {
13461346

13471347
/**
13481348
* <p>By default, when you create a new association, the system runs it immediately after it is
1349-
* created and then according to the schedule you specified. Specify this option if you don't want
1350-
* an association to run immediately after you create it. This parameter isn't supported for rate
1351-
* expressions.</p>
1349+
* created and then according to the schedule you specified and when target changes are detected.
1350+
* Specify <code>true</code> for <code>ApplyOnlyAtCronInterval</code>if you want the association to
1351+
* run only according to the schedule you specified.</p>
1352+
* <p>For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling">Understanding when associations are applied to resources</a> and <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates">>About
1353+
* target updates with Automation runbooks</a> in the
1354+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
1355+
* <p>This parameter isn't supported for rate expressions.</p>
13521356
* @public
13531357
*/
13541358
ApplyOnlyAtCronInterval?: boolean | undefined;
13551359

13561360
/**
1357-
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to
1361+
* <p>The names of Amazon Resource Names (ARNs) of the Change Calendar type documents you want to
13581362
* gate your associations under. The associations only run when that change calendar is open. For
13591363
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
1360-
* Calendar</a>.</p>
1364+
* Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
13611365
* @public
13621366
*/
13631367
CalendarNames?: string[] | undefined;
@@ -1671,7 +1675,7 @@ export interface AssociationDescription {
16711675
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your
16721676
* associations are gated under. The associations only run when that change calendar is open. For
16731677
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
1674-
* Calendar</a>.</p>
1678+
* Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
16751679
* @public
16761680
*/
16771681
CalendarNames?: string[] | undefined;
@@ -2047,10 +2051,14 @@ export interface CreateAssociationBatchRequestEntry {
20472051
SyncCompliance?: AssociationSyncCompliance | undefined;
20482052

20492053
/**
2050-
* <p>By default, when you create a new associations, the system runs it immediately after it is
2051-
* created and then according to the schedule you specified. Specify this option if you don't want
2052-
* an association to run immediately after you create it. This parameter isn't supported for rate
2053-
* expressions.</p>
2054+
* <p>By default, when you create a new association, the system runs it immediately after it is
2055+
* created and then according to the schedule you specified and when target changes are detected.
2056+
* Specify <code>true</code> for <code>ApplyOnlyAtCronInterval</code> if you want the association to
2057+
* run only according to the schedule you specified.</p>
2058+
* <p>For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling">Understanding when associations are applied to resources</a> and <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates">>About
2059+
* target updates with Automation runbooks</a> in the
2060+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
2061+
* <p>This parameter isn't supported for rate expressions.</p>
20542062
* @public
20552063
*/
20562064
ApplyOnlyAtCronInterval?: boolean | undefined;
@@ -2059,7 +2067,7 @@ export interface CreateAssociationBatchRequestEntry {
20592067
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your
20602068
* associations are gated under. The associations only run when that Change Calendar is open. For
20612069
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
2062-
* Calendar</a>.</p>
2070+
* Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
20632071
* @public
20642072
*/
20652073
CalendarNames?: string[] | undefined;
@@ -4767,6 +4775,11 @@ export interface DeleteParameterResult {}
47674775

47684776
/**
47694777
* <p>The parameter couldn't be found. Verify the name and try again.</p>
4778+
* <note>
4779+
* <p>For the <code>DeleteParameter</code> and <code>GetParameter</code> actions, if the
4780+
* specified parameter doesn't exist, the <code>ParameterNotFound</code> exception is
4781+
* <i>not</i> recorded in CloudTrail event logs.</p>
4782+
* </note>
47704783
* @public
47714784
*/
47724785
export class ParameterNotFound extends __BaseException {

‎clients/client-ssm/src/models/models_1.ts

+12-11
Original file line numberDiff line numberDiff line change
@@ -2144,7 +2144,7 @@ export interface GetAutomationExecutionResult {
21442144
*/
21452145
export interface GetCalendarStateRequest {
21462146
/**
2147-
* <p>The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that
2147+
* <p>The names of Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that
21482148
* represent the calendar entries for which you want to get the state.</p>
21492149
* @public
21502150
*/
@@ -5976,7 +5976,7 @@ export interface AssociationVersionInfo {
59765976
SyncCompliance?: AssociationSyncCompliance | undefined;
59775977

59785978
/**
5979-
* <p>By default, when you create a new associations, the system runs it immediately after it is
5979+
* <p>By default, when you create new associations, the system runs it immediately after it is
59805980
* created and then according to the schedule you specified. Specify this option if you don't want
59815981
* an association to run immediately after you create it. This parameter isn't supported for rate
59825982
* expressions.</p>
@@ -5988,7 +5988,7 @@ export interface AssociationVersionInfo {
59885988
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your
59895989
* associations are gated under. The associations for this version only run when that Change
59905990
* Calendar is open. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
5991-
* Calendar</a>.</p>
5991+
* Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
59925992
* @public
59935993
*/
59945994
CalendarNames?: string[] | undefined;
@@ -8142,9 +8142,10 @@ export interface NodeFilter {
81428142
*/
81438143
export interface ListNodesRequest {
81448144
/**
8145-
* <p>The name of the resource data sync to retrieve information about. Required for
8146-
* cross-account/cross-Region configurations. Optional for single account/single-Region
8147-
* configurations.</p>
8145+
* <p>The name of the Amazon Web Services managed resource data sync to retrieve information about.</p>
8146+
* <p>For cross-account/cross-Region configurations, this parameter is required, and the name of
8147+
* the supported resource data sync is <code>AWS-QuickSetup-ManagedNode</code>.</p>
8148+
* <p>For single account/single-Region configurations, the parameter is not required.</p>
81488149
* @public
81498150
*/
81508151
SyncName?: string | undefined;
@@ -9251,7 +9252,7 @@ export interface ModifyDocumentPermissionRequest {
92519252

92529253
/**
92539254
* <p>The Amazon Web Services users that should have access to the document. The account IDs can either be a
9254-
* group of account IDs or <i>All</i>.</p>
9255+
* group of account IDs or <i>All</i>. </p>
92559256
* @public
92569257
*/
92579258
AccountIdsToAdd?: string[] | undefined;
@@ -9260,7 +9261,7 @@ export interface ModifyDocumentPermissionRequest {
92609261
* <p>The Amazon Web Services users that should no longer have access to the document. The Amazon Web Services user
92619262
* can either be a group of account IDs or <i>All</i>. This action has a higher
92629263
* priority than <code>AccountIdsToAdd</code>. If you specify an ID to add and the same ID to
9263-
* remove, the system removes access to the document.</p>
9264+
* remove, the system removes access to the document. </p>
92649265
* @public
92659266
*/
92669267
AccountIdsToRemove?: string[] | undefined;
@@ -9961,7 +9962,7 @@ export class PoliciesLimitExceededException extends __BaseException {
99619962
*/
99629963
export interface PutParameterRequest {
99639964
/**
9964-
* <p>The fully qualified name of the parameter that you want to add to the system.</p>
9965+
* <p>The fully qualified name of the parameter that you want to create or update.</p>
99659966
* <note>
99669967
* <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name
99679968
* itself.</p>
@@ -10031,7 +10032,7 @@ export interface PutParameterRequest {
1003110032
Value: string | undefined;
1003210033

1003310034
/**
10034-
* <p>The type of parameter that you want to add to the system.</p>
10035+
* <p>The type of parameter that you want to create.</p>
1003510036
* <note>
1003610037
* <p>
1003710038
* <code>SecureString</code> isn't currently supported for CloudFormation templates.</p>
@@ -10051,7 +10052,7 @@ export interface PutParameterRequest {
1005110052
* <p>The Key Management Service (KMS) ID that you want to use to encrypt a
1005210053
* parameter. Use a custom key for better security. Required for parameters that use the <code>SecureString</code> data type.</p>
1005310054
* <p>If you don't specify a key ID, the system uses the default key associated with your
10054-
* Amazon Web Services account which is not as secure as using a custom key.</p>
10055+
* Amazon Web Services account, which is not as secure as using a custom key.</p>
1005510056
* <ul>
1005610057
* <li>
1005710058
* <p>To use a custom KMS key, choose the <code>SecureString</code>

‎clients/client-ssm/src/models/models_2.ts

+23-17
Original file line numberDiff line numberDiff line change
@@ -1463,20 +1463,25 @@ export interface UpdateAssociationRequest {
14631463

14641464
/**
14651465
* <p>By default, when you update an association, the system runs it immediately after it is
1466-
* updated and then according to the schedule you specified. Specify this option if you don't want
1467-
* an association to run immediately after you update it. This parameter isn't supported for rate
1468-
* expressions.</p>
1466+
* updated and then according to the schedule you specified. Specify <code>true</code> for
1467+
* <code>ApplyOnlyAtCronInterval</code> if you want the association to run only according to the
1468+
* schedule you specified.</p>
14691469
* <p>If you chose this option when you created an association and later you edit that association
1470-
* or you make changes to the SSM document on which that association is based (by using the
1471-
* Documents page in the console), State Manager applies the association at the next specified cron
1472-
* interval. For example, if you chose the <code>Latest</code> version of an SSM document when you
1473-
* created an association and you edit the association by choosing a different document version on
1474-
* the Documents page, State Manager applies the association at the next specified cron interval if
1475-
* you previously selected this option. If this option wasn't selected, State Manager immediately
1476-
* runs the association.</p>
1477-
* <p>You can reset this option. To do so, specify the <code>no-apply-only-at-cron-interval</code>
1478-
* parameter when you update the association from the command line. This parameter forces the
1479-
* association to run immediately after updating it and according to the interval specified.</p>
1470+
* or you make changes to the Automation runbook or SSM document on which that association is based,
1471+
* State Manager applies the association at the next specified cron interval. For example, if you
1472+
* chose the <code>Latest</code> version of an SSM document when you created an association and you
1473+
* edit the association by choosing a different document version on the Documents page, State
1474+
* Manager applies the association at the next specified cron interval if you previously set
1475+
* <code>ApplyOnlyAtCronInterval</code> to <code>true</code>. If this option wasn't selected, State
1476+
* Manager immediately runs the association.</p>
1477+
* <p>For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#state-manager-about-scheduling">Understanding when associations are applied to resources</a> and <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/state-manager-about.html#runbook-target-updates">About
1478+
* target updates with Automation runbooks</a> in the
1479+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
1480+
* <p>This parameter isn't supported for rate expressions.</p>
1481+
* <p>You can reset this parameter. To do so, specify the
1482+
* <code>no-apply-only-at-cron-interval</code> parameter when you update the association from the
1483+
* command line. This parameter forces the association to run immediately after updating it and
1484+
* according to the interval specified.</p>
14801485
* @public
14811486
*/
14821487
ApplyOnlyAtCronInterval?: boolean | undefined;
@@ -1485,7 +1490,7 @@ export interface UpdateAssociationRequest {
14851490
* <p>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to
14861491
* gate your associations under. The associations only run when that change calendar is open. For
14871492
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar">Amazon Web Services Systems Manager Change
1488-
* Calendar</a>.</p>
1493+
* Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
14891494
* @public
14901495
*/
14911496
CalendarNames?: string[] | undefined;
@@ -3259,9 +3264,10 @@ export interface GetOpsSummaryRequest {
32593264
*/
32603265
export interface ListNodesSummaryRequest {
32613266
/**
3262-
* <p>The name of the resource data sync to retrieve information about. Required for
3263-
* cross-account/cross-Region configuration. Optional for single account/single-Region
3264-
* configurations.</p>
3267+
* <p>The name of the Amazon Web Services managed resource data sync to retrieve information about.</p>
3268+
* <p>For cross-account/cross-Region configurations, this parameter is required, and the name of
3269+
* the supported resource data sync is <code>AWS-QuickSetup-ManagedNode</code>.</p>
3270+
* <p>For single account/single-Region configurations, the parameter is not required.</p>
32653271
* @public
32663272
*/
32673273
SyncName?: string | undefined;

0 commit comments

Comments
 (0)