Skip to content

Commit e298b14

Browse files
author
awstools
committed
docs(client-ssm): Systems Manager doc-only update for June 2023.
1 parent 5661064 commit e298b14

15 files changed

+579
-184
lines changed

clients/client-ssm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ operations at scale.</p>
1515
</p>
1616
<ul>
1717
<li>
18-
<p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
18+
<p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
1919
</li>
2020
<li>
2121
<p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the

clients/client-ssm/src/SSM.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3065,7 +3065,7 @@ export interface SSM {
30653065
* </p>
30663066
* <ul>
30673067
* <li>
3068-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3068+
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
30693069
* </li>
30703070
* <li>
30713071
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the

clients/client-ssm/src/SSMClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -934,7 +934,7 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
934934
* </p>
935935
* <ul>
936936
* <li>
937-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
937+
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/systems-manager-capabilities.html">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
938938
* </li>
939939
* <li>
940940
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the

clients/client-ssm/src/commands/AssociateOpsItemRelatedItemCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,7 @@ export interface AssociateOpsItemRelatedItemCommandOutput
7575
* again.</p>
7676
*
7777
* @throws {@link OpsItemLimitExceededException} (client fault)
78-
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
79-
* quotas, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits">What are the resource limits for OpsCenter?</a>.</p>
78+
* <p>The request caused OpsItems to exceed one or more quotas.</p>
8079
*
8180
* @throws {@link OpsItemNotFoundException} (client fault)
8281
* <p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>

clients/client-ssm/src/commands/CreateOpsItemCommand.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface CreateOpsItemCommandOutput extends CreateOpsItemResponse, __Met
3636

3737
/**
3838
* @public
39-
* <p>Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html">Getting started with
40-
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
39+
* <p>Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the
40+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
4141
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
4242
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
4343
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the
@@ -115,8 +115,7 @@ export interface CreateOpsItemCommandOutput extends CreateOpsItemResponse, __Met
115115
* again.</p>
116116
*
117117
* @throws {@link OpsItemLimitExceededException} (client fault)
118-
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
119-
* quotas, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits">What are the resource limits for OpsCenter?</a>.</p>
118+
* <p>The request caused OpsItems to exceed one or more quotas.</p>
120119
*
121120
* @throws {@link SSMServiceException}
122121
* <p>Base exception class for all service exceptions from SSM service.</p>

clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,15 @@ export interface DescribeInstanceInformationCommandOutput extends DescribeInstan
3636

3737
/**
3838
* @public
39-
* <p>Describes one or more of your managed nodes, including information about the operating
40-
* system platform, the version of SSM Agent installed on the managed node, node status, and so
41-
* on.</p>
42-
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes.
43-
* If you don't specify node IDs, it returns information for all your managed nodes. If you specify
44-
* a node ID that isn't valid or a node that you don't own, you receive an error.</p>
39+
* <p>Provides information about one or more of your managed nodes, including the operating system
40+
* platform, SSM Agent version, association status, and IP address. This operation does not return
41+
* information for nodes that are either Stopped or Terminated.</p>
42+
* <p>If you specify one or more node IDs, the operation returns information for those managed
43+
* nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you
44+
* specify a node ID that isn't valid or a node that you don't own, you receive an error.</p>
4545
* <note>
46-
* <p>The <code>IamRole</code> field for this API operation is the Identity and Access Management
47-
* (IAM) role assigned to on-premises managed nodes. This call doesn't return the
48-
* IAM role for EC2 instances.</p>
46+
* <p>The <code>IamRole</code> field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not
47+
* return the IAM role for EC2 instances.</p>
4948
* </note>
5049
* @example
5150
* Use a bare-bones client and the command you need to make an API call.

clients/client-ssm/src/commands/DescribeOpsItemsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface DescribeOpsItemsCommandOutput extends DescribeOpsItemsResponse,
3636

3737
/**
3838
* @public
39-
* <p>Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html">Getting started with
40-
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
39+
* <p>Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the
40+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
4141
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
4242
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
4343
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the

clients/client-ssm/src/commands/GetOpsItemCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ export interface GetOpsItemCommandOutput extends GetOpsItemResponse, __MetadataB
3737
/**
3838
* @public
3939
* <p>Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information,
40-
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html">Getting started with
41-
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
40+
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set
41+
* up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
4242
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
4343
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
4444
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the

clients/client-ssm/src/commands/ListOpsItemEventsCommand.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,7 @@ export interface ListOpsItemEventsCommandOutput extends ListOpsItemEventsRespons
9292
* again.</p>
9393
*
9494
* @throws {@link OpsItemLimitExceededException} (client fault)
95-
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
96-
* quotas, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits">What are the resource limits for OpsCenter?</a>.</p>
95+
* <p>The request caused OpsItems to exceed one or more quotas.</p>
9796
*
9897
* @throws {@link OpsItemNotFoundException} (client fault)
9998
* <p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>

clients/client-ssm/src/commands/UpdateOpsItemCommand.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ export interface UpdateOpsItemCommandOutput extends UpdateOpsItemResponse, __Met
3636

3737
/**
3838
* @public
39-
* <p>Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html">Getting started with
40-
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
39+
* <p>Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up OpsCenter</a> in the
40+
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
4141
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
4242
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
4343
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
@@ -109,8 +109,7 @@ export interface UpdateOpsItemCommandOutput extends UpdateOpsItemResponse, __Met
109109
* again.</p>
110110
*
111111
* @throws {@link OpsItemLimitExceededException} (client fault)
112-
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
113-
* quotas, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-learn-more.html#OpsCenter-learn-more-limits">What are the resource limits for OpsCenter?</a>.</p>
112+
* <p>The request caused OpsItems to exceed one or more quotas.</p>
114113
*
115114
* @throws {@link OpsItemNotFoundException} (client fault)
116115
* <p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>

0 commit comments

Comments
 (0)