Skip to content

Commit

Permalink
docs(client-ssm): Systems Manager doc-only update for June 2023.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jun 27, 2023
1 parent 5661064 commit e298b14
Show file tree
Hide file tree
Showing 15 changed files with 579 additions and 184 deletions.
2 changes: 1 addition & 1 deletion clients/client-ssm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ operations at scale.</p>
</p>
<ul>
<li>
<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>
<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>
</li>
<li>
<p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ssm/src/SSM.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3065,7 +3065,7 @@ export interface SSM {
* </p>
* <ul>
* <li>
* <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>
* <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>
* </li>
* <li>
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ssm/src/SSMClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -934,7 +934,7 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
* </p>
* <ul>
* <li>
* <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>
* <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>
* </li>
* <li>
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,7 @@ export interface AssociateOpsItemRelatedItemCommandOutput
* again.</p>
*
* @throws {@link OpsItemLimitExceededException} (client fault)
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
* 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>
* <p>The request caused OpsItems to exceed one or more quotas.</p>
*
* @throws {@link OpsItemNotFoundException} (client fault)
* <p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>
Expand Down
7 changes: 3 additions & 4 deletions clients/client-ssm/src/commands/CreateOpsItemCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface CreateOpsItemCommandOutput extends CreateOpsItemResponse, __Met

/**
* @public
* <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
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <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
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
* 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
Expand Down Expand Up @@ -115,8 +115,7 @@ export interface CreateOpsItemCommandOutput extends CreateOpsItemResponse, __Met
* again.</p>
*
* @throws {@link OpsItemLimitExceededException} (client fault)
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
* 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>
* <p>The request caused OpsItems to exceed one or more quotas.</p>
*
* @throws {@link SSMServiceException}
* <p>Base exception class for all service exceptions from SSM service.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,15 @@ export interface DescribeInstanceInformationCommandOutput extends DescribeInstan

/**
* @public
* <p>Describes one or more of your managed nodes, including information about the operating
* system platform, the version of SSM Agent installed on the managed node, node status, and so
* on.</p>
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes.
* If you don't specify node IDs, it returns information for all your managed nodes. If you specify
* a node ID that isn't valid or a node that you don't own, you receive an error.</p>
* <p>Provides information about one or more of your managed nodes, including the operating system
* platform, SSM Agent version, association status, and IP address. This operation does not return
* information for nodes that are either Stopped or Terminated.</p>
* <p>If you specify one or more node IDs, the operation returns information for those managed
* nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you
* specify a node ID that isn't valid or a node that you don't own, you receive an error.</p>
* <note>
* <p>The <code>IamRole</code> field for this API operation is the Identity and Access Management
* (IAM) role assigned to on-premises managed nodes. This call doesn't return the
* IAM role for EC2 instances.</p>
* <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
* return the IAM role for EC2 instances.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
4 changes: 2 additions & 2 deletions clients/client-ssm/src/commands/DescribeOpsItemsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface DescribeOpsItemsCommandOutput extends DescribeOpsItemsResponse,

/**
* @public
* <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
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <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
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
Expand Down
4 changes: 2 additions & 2 deletions clients/client-ssm/src/commands/GetOpsItemCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ export interface GetOpsItemCommandOutput extends GetOpsItemResponse, __MetadataB
/**
* @public
* <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,
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html">Getting started with
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set
* up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
Expand Down
3 changes: 1 addition & 2 deletions clients/client-ssm/src/commands/ListOpsItemEventsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,7 @@ export interface ListOpsItemEventsCommandOutput extends ListOpsItemEventsRespons
* again.</p>
*
* @throws {@link OpsItemLimitExceededException} (client fault)
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
* 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>
* <p>The request caused OpsItems to exceed one or more quotas.</p>
*
* @throws {@link OpsItemNotFoundException} (client fault)
* <p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>
Expand Down
7 changes: 3 additions & 4 deletions clients/client-ssm/src/commands/UpdateOpsItemCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ export interface UpdateOpsItemCommandOutput extends UpdateOpsItemResponse, __Met

/**
* @public
* <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
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <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
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
Expand Down Expand Up @@ -109,8 +109,7 @@ export interface UpdateOpsItemCommandOutput extends UpdateOpsItemResponse, __Met
* again.</p>
*
* @throws {@link OpsItemLimitExceededException} (client fault)
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
* 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>
* <p>The request caused OpsItems to exceed one or more quotas.</p>
*
* @throws {@link OpsItemNotFoundException} (client fault)
* <p>The specified OpsItem ID doesn't exist. Verify the ID and try again.</p>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ssm/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* </p>
* <ul>
* <li>
* <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>
* <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>
* </li>
* <li>
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
Expand Down
30 changes: 14 additions & 16 deletions clients/client-ssm/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ export interface AddTagsToResourceRequest {
* <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or
* <code>/aws/ssm/MyGroup/appmanager</code>.</p>
* <p>For the <code>Document</code> and <code>Parameter</code> values, use the name of the
* resource.</p>
* resource. If you're tagging a shared document, you must use the full ARN of the document.</p>
* <p>
* <code>ManagedInstance</code>: <code>mi-012345abcde</code>
* </p>
Expand Down Expand Up @@ -442,8 +442,7 @@ export class OpsItemInvalidParameterException extends __BaseException {

/**
* @public
* <p>The request caused OpsItems to exceed one or more quotas. For information about OpsItem
* 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>
* <p>The request caused OpsItems to exceed one or more quotas.</p>
*/
export class OpsItemLimitExceededException extends __BaseException {
readonly name: "OpsItemLimitExceededException" = "OpsItemLimitExceededException";
Expand Down Expand Up @@ -2903,7 +2902,8 @@ export interface CreateOpsItemRequest {
* <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in
* the request. Use the <code>/aws/automations</code> key in OperationalData to associate an
* Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see
* <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html">Creating OpsItems
* manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
*/
OperationalData?: Record<string, OpsItemDataValue>;

Expand Down Expand Up @@ -2940,8 +2940,7 @@ export interface CreateOpsItemRequest {
Title: string | undefined;

/**
* <p>Optional metadata that you assign to a resource. You can restrict access to OpsItems by
* using an inline IAM policy that specifies tags. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html#OpsCenter-getting-started-user-permissions">Getting started with OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* <p>Optional metadata that you assign to a resource.</p>
* <p>Tags use a key-value pair. For example:</p>
* <p>
* <code>Key=Department,Value=Finance</code>
Expand Down Expand Up @@ -2991,9 +2990,8 @@ export interface CreateOpsItemRequest {

/**
* <p>The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account
* must be configured to work with OpsItems across accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-OpsCenter-multiple-accounts.html">Setting
* up OpsCenter to work with OpsItems across accounts</a> in the
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* must be configured to work with OpsItems across accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html">Set up
* OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
*/
AccountId?: string;
}
Expand Down Expand Up @@ -6749,14 +6747,16 @@ export interface DescribeInstanceInformationRequest {

/**
* <p>One or more filters. Use a filter to return a more specific list of managed nodes. You can
* filter based on tags applied to your managed nodes. Use this <code>Filters</code> data type
* instead of <code>InstanceInformationFilterList</code>, which is deprecated.</p>
* filter based on tags applied to your managed nodes. Tag filters can't be combined with other
* filter types. Use this <code>Filters</code> data type instead of
* <code>InstanceInformationFilterList</code>, which is deprecated.</p>
*/
Filters?: InstanceInformationStringFilter[];

/**
* <p>The maximum number of items to return for this call. The call also returns a token that you
* can specify in a subsequent call to get the next set of results. </p>
* can specify in a subsequent call to get the next set of results. The default value is 10 items.
* </p>
*/
MaxResults?: number;

Expand Down Expand Up @@ -6889,8 +6889,7 @@ export interface InstanceInformation {
* <p>The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager
* managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud
* (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use
* the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href="https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html">describe-instances</a> in
* the <i>Amazon Web Services CLI Command Reference</i>.</p>
* the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html">describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>
*/
IamRole?: string;

Expand All @@ -6912,8 +6911,7 @@ export interface InstanceInformation {
* explained in <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html">Install SSM Agent for a
* hybrid environment (Linux)</a> and <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html">Install SSM Agent for a
* hybrid environment (Windows)</a>. To retrieve the <code>Name</code> tag of an EC2 instance,
* use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href="https://docs.aws.amazon.com/cli/latest/ec2/describe-instances.html">describe-instances</a> in
* the <i>Amazon Web Services CLI Command Reference</i>.</p>
* use the Amazon EC2 <code>DescribeInstances</code> operation. For information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html">DescribeInstances</a> in the <i>Amazon EC2 API Reference</i> or <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html">describe-instances</a> in the <i>Amazon Web Services CLI Command Reference</i>.</p>
*/
Name?: string;

Expand Down
Loading

0 comments on commit e298b14

Please sign in to comment.