Skip to content

Commit

Permalink
Systems Manager doc-only update for January, 2025.
Browse files Browse the repository at this point in the history
  • Loading branch information
aws-sdk-dotnet-automation committed Jan 24, 2025
1 parent 38d56ef commit 6828950
Show file tree
Hide file tree
Showing 32 changed files with 369 additions and 352 deletions.
62 changes: 31 additions & 31 deletions generator/ServiceModels/ssm/ssm-2014-11-06.docs.json

Large diffs are not rendered by default.

62 changes: 31 additions & 31 deletions generator/ServiceModels/ssm/ssm-2014-11-06.normal.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace Amazon.SimpleSystemsManagement.Model
/// Container for the parameters to the AssociateOpsItemRelatedItem operation.
/// Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you
/// can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager
/// and OpsCenter are capabilities of Amazon Web Services Systems Manager.
/// and OpsCenter are tools in Amazon Web Services Systems Manager.
/// </summary>
public partial class AssociateOpsItemRelatedItemRequest : AmazonSimpleSystemsManagementRequest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ internal bool IsSetAssociationVersion()
/// <para>
/// Choose the parameter that will define how your automation will branch out. This target
/// is required for associations that use an Automation runbook and target resources by
/// using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
/// using rate controls. Automation is a tool in Amazon Web Services Systems Manager.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=50)]
Expand Down Expand Up @@ -546,8 +546,8 @@ internal bool IsSetStatus()
/// <para>
/// In <c>MANUAL</c> mode, you must specify the <c>AssociationId</c> as a parameter for
/// the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed
/// by State Manager, a capability of Amazon Web Services Systems Manager. It is managed
/// by your direct call to the <a>PutComplianceItems</a> API operation.
/// by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by
/// your direct call to the <a>PutComplianceItems</a> API operation.
/// </para>
///
/// <para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -396,8 +396,8 @@ internal bool IsSetScheduleOffset()
/// <para>
/// In <c>MANUAL</c> mode, you must specify the <c>AssociationId</c> as a parameter for
/// the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed
/// by State Manager, a capability of Amazon Web Services Systems Manager. It is managed
/// by your direct call to the <a>PutComplianceItems</a> API operation.
/// by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by
/// your direct call to the <a>PutComplianceItems</a> API operation.
/// </para>
///
/// <para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -437,8 +437,8 @@ internal bool IsSetRequestedDateTime()
/// <summary>
/// Gets and sets the property ServiceRole.
/// <para>
/// The Identity and Access Management (IAM) service role that Run Command, a capability
/// of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications
/// The Identity and Access Management (IAM) service role that Run Command, a tool in
/// Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications
/// about command status changes.
/// </para>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,8 @@ internal bool IsSetRequestedDateTime()
/// <summary>
/// Gets and sets the property ServiceRole.
/// <para>
/// The Identity and Access Management (IAM) service role that Run Command, a capability
/// of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications
/// The Identity and Access Management (IAM) service role that Run Command, a tool in
/// Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications
/// about command status changes on a per managed node basis.
/// </para>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ namespace Amazon.SimpleSystemsManagement.Model
/// Generates an activation code and activation ID you can use to register your on-premises
/// servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.
/// Registering these machines with Systems Manager makes it possible to manage them using
/// Systems Manager capabilities. You use the activation code and ID when installing SSM
/// Agent on machines in your hybrid environment. For more information about requirements
/// for managing on-premises machines using Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html">Using
/// Systems Manager tools. You use the activation code and ID when installing SSM Agent
/// on machines in your hybrid environment. For more information about requirements for
/// managing on-premises machines using Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-hybrid-multicloud.html">Using
/// Amazon Web Services Systems Manager in hybrid and multicloud environments</a> in the
/// <i>Amazon Web Services Systems Manager User Guide</i>.
///
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ internal bool IsSetAssociationName()
/// <para>
/// Specify the target for the association. This target is required for associations that
/// use an Automation runbook and target resources by using rate controls. Automation
/// is a capability of Amazon Web Services Systems Manager.
/// is a tool in Amazon Web Services Systems Manager.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=50)]
Expand Down Expand Up @@ -454,8 +454,8 @@ internal bool IsSetScheduleOffset()
/// <para>
/// In <c>MANUAL</c> mode, you must specify the <c>AssociationId</c> as a parameter for
/// the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed
/// by State Manager, a capability of Amazon Web Services Systems Manager. It is managed
/// by your direct call to the <a>PutComplianceItems</a> API operation.
/// by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by
/// your direct call to the <a>PutComplianceItems</a> API operation.
/// </para>
///
/// <para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ namespace Amazon.SimpleSystemsManagement.Model
/// and running on your managed nodes, or that certain ports must be closed. For static
/// targets, the association specifies a schedule for when the configuration is reapplied.
/// For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web
/// Services autoscaling group, State Manager, a capability of Amazon Web Services Systems
/// Manager applies the configuration when new managed nodes are added to the group. The
/// association also specifies actions to take when applying the configuration. For example,
/// an association for anti-virus software might run once a day. If the software isn't
/// installed, then State Manager installs it. If the software is installed, but the service
/// isn't running, then the association might instruct State Manager to start the service.
/// Services autoscaling group, State Manager, a tool in Amazon Web Services Systems Manager
/// applies the configuration when new managed nodes are added to the group. The association
/// also specifies actions to take when applying the configuration. For example, an association
/// for anti-virus software might run once a day. If the software isn't installed, then
/// State Manager installs it. If the software is installed, but the service isn't running,
/// then the association might instruct State Manager to start the service.
/// </summary>
public partial class CreateAssociationRequest : AmazonSimpleSystemsManagementRequest
{
Expand Down Expand Up @@ -142,7 +142,7 @@ internal bool IsSetAssociationName()
/// <para>
/// Choose the parameter that will define how your automation will branch out. This target
/// is required for associations that use an Automation runbook and target resources by
/// using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
/// using rate controls. Automation is a tool in Amazon Web Services Systems Manager.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=50)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,8 @@ internal bool IsSetInstancesWithSecurityNonCompliantPatches()
/// Gets and sets the property InstancesWithUnreportedNotApplicablePatches.
/// <para>
/// The number of managed nodes with <c>NotApplicable</c> patches beyond the supported
/// limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon
/// Web Services Systems Manager.
/// limit, which aren't reported by name to Inventory. Inventory is a tool in Amazon Web
/// Services Systems Manager.
/// </para>
/// </summary>
public int InstancesWithUnreportedNotApplicablePatches
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace Amazon.SimpleSystemsManagement.Model
/// Container for the parameters to the DisassociateOpsItemRelatedItem operation.
/// Deletes the association between an OpsItem and a related item. For example, this API
/// operation can delete an Incident Manager incident from an OpsItem. Incident Manager
/// is a capability of Amazon Web Services Systems Manager.
/// is a tool in Amazon Web Services Systems Manager.
/// </summary>
public partial class DisassociateOpsItemRelatedItemRequest : AmazonSimpleSystemsManagementRequest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ namespace Amazon.SimpleSystemsManagement.Model
/// </para>
///
/// <para>
/// For more information about Change Calendar, a capability of Amazon Web Services Systems
/// For more information about Change Calendar, a tool in Amazon Web Services Systems
/// Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html">Amazon
/// Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems
/// Manager User Guide</i>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ namespace Amazon.SimpleSystemsManagement.Model
/// If you run the command locally, such as with the Command Line Interface (CLI), the
/// system attempts to use your local Amazon Web Services credentials and the operation
/// fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager
/// console. Use Run Command, a capability of Amazon Web Services Systems Manager, with
/// an SSM document that enables you to target a managed node with a script or command.
/// For example, run the command using the <c>AWS-RunShellScript</c> document or the <c>AWS-RunPowerShellScript</c>
/// console. Use Run Command, a tool in Amazon Web Services Systems Manager, with an SSM
/// document that enables you to target a managed node with a script or command. For example,
/// run the command using the <c>AWS-RunShellScript</c> document or the <c>AWS-RunPowerShellScript</c>
/// document.
/// </para>
/// </note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ namespace Amazon.SimpleSystemsManagement.Model
{
/// <summary>
/// Container for the parameters to the GetParametersByPath operation.
/// Retrieve information about one or more parameters in a specific hierarchy.
/// Retrieve information about one or more parameters under a specified level in a hierarchy.
///
///
///
/// <para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -513,8 +513,8 @@ internal bool IsSetSnapshotId()
/// Gets and sets the property UnreportedNotApplicableCount.
/// <para>
/// The number of patches beyond the supported limit of <c>NotApplicableCount</c> that
/// aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services
/// Systems Manager.
/// aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems
/// Manager.
/// </para>
/// </summary>
public int UnreportedNotApplicableCount
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ namespace Amazon.SimpleSystemsManagement.Model
/// Container for the parameters to the ListAssociations operation.
/// Returns all State Manager associations in the current Amazon Web Services account
/// and Amazon Web Services Region. You can limit the results to a specific State Manager
/// association document or managed node by specifying a filter. State Manager is a capability
/// of Amazon Web Services Systems Manager.
/// association document or managed node by specifying a filter. State Manager is a tool
/// in Amazon Web Services Systems Manager.
/// </summary>
public partial class ListAssociationsRequest : AmazonSimpleSystemsManagementRequest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ namespace Amazon.SimpleSystemsManagement.Model
/// <summary>
/// Container for the parameters to the ListOpsItemRelatedItems operation.
/// Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
/// OpsCenter is a capability of Amazon Web Services Systems Manager.
/// OpsCenter is a tool in Amazon Web Services Systems Manager.
/// </summary>
public partial class ListOpsItemRelatedItemsRequest : AmazonSimpleSystemsManagementRequest
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ internal bool IsSetPolicyText()
/// <summary>
/// Gets and sets the property PolicyType.
/// <para>
/// The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager,
/// The type of policy. Parameter Store, a tool in Amazon Web Services Systems Manager,
/// supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
///
/// </para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -284,8 +284,8 @@ internal bool IsSetOverwrite()
/// Gets and sets the property Policies.
/// <para>
/// One or more policies to apply to a parameter. This operation takes a JSON array. Parameter
/// Store, a capability of Amazon Web Services Systems Manager supports the following
/// policy types:
/// Store, a tool in Amazon Web Services Systems Manager supports the following policy
/// types:
/// </para>
///
/// <para>
Expand Down Expand Up @@ -522,7 +522,8 @@ internal bool IsSetType()
/// <note>
/// <para>
/// Parameters can't be referenced or nested in the values of other parameters. You can't
/// include <c>{{}}</c> or <c>{{ssm:<i>parameter-name</i>}}</c> in a parameter value.
/// include values wrapped in double brackets <c>{{}}</c> or <c>{{ssm:<i>parameter-name</i>}}</c>
/// in a parameter value.
/// </para>
/// </note>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ internal bool IsSetAlarmConfiguration()
/// Gets and sets the property CloudWatchOutputConfig.
/// <para>
/// Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch
/// Logs. Run Command is a capability of Amazon Web Services Systems Manager.
/// Logs. Run Command is a tool in Amazon Web Services Systems Manager.
/// </para>
/// </summary>
public CloudWatchOutputConfig CloudWatchOutputConfig
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,10 @@ internal bool IsSetParameters()
/// </para>
/// </li> </ul> <note>
/// <para>
/// To add tags to an existing automation, use the <a>AddTagsToResource</a> operation.
/// The <c>Array Members</c> maximum value is reported as 1000. This number includes capacity
/// reserved for internal operations. When calling the <c>StartAutomationExecution</c>
/// action, you can specify a maximum of 5 tags. You can, however, use the <a>AddTagsToResource</a>
/// action to add up to a total of 50 tags to an existing automation configuration.
/// </para>
/// </note>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,14 @@ internal bool IsSetScheduledTime()
/// <para>
/// <c>Key=Region,Value=us-east-2</c>
/// </para>
/// </li> </ul>
/// </li> </ul> <note>
/// <para>
/// The <c>Array Members</c> maximum value is reported as 1000. This number includes capacity
/// reserved for internal operations. When calling the <c>StartChangeRequestExecution</c>
/// action, you can specify a maximum of 5 tags. You can, however, use the <a>AddTagsToResource</a>
/// action to add up to a total of 50 tags to an existing change request configuration.
/// </para>
/// </note>
/// </summary>
[AWSProperty(Max=1000)]
public List<Tag> Tags
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,9 @@ internal bool IsSetDocumentName()
/// Gets and sets the property Parameters.
/// <para>
/// The values you want to specify for the parameters defined in the Session document.
/// For more information about these parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/getting-started-create-preferences-cli.html">Create
/// a Session Manager preferences document</a> in the <i>Amazon Web Services Systems Manager
/// User Guide</i>.
/// </para>
/// </summary>
public Dictionary<string, List<string>> Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ namespace Amazon.SimpleSystemsManagement.Model
/// </para>
///
/// <para>
/// <b>For all Systems Manager capabilities:</b>
/// <b>For all Systems Manager tools:</b>
/// </para>
/// <ul> <li>
/// <para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ internal bool IsSetAssociationVersion()
/// <para>
/// Choose the parameter that will define how your automation will branch out. This target
/// is required for associations that use an Automation runbook and target resources by
/// using rate controls. Automation is a capability of Amazon Web Services Systems Manager.
/// using rate controls. Automation is a tool in Amazon Web Services Systems Manager.
/// </para>
/// </summary>
[AWSProperty(Min=1, Max=50)]
Expand Down Expand Up @@ -452,7 +452,7 @@ internal bool IsSetOutputLocation()
/// Gets and sets the property Parameters.
/// <para>
/// The parameters you want to update for the association. If you create a parameter using
/// Parameter Store, a capability of Amazon Web Services Systems Manager, you can reference
/// Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference
/// the parameter using <c>{{ssm:parameter-name}}</c>.
/// </para>
/// </summary>
Expand Down Expand Up @@ -532,8 +532,8 @@ internal bool IsSetScheduleOffset()
/// <para>
/// In <c>MANUAL</c> mode, you must specify the <c>AssociationId</c> as a parameter for
/// the <a>PutComplianceItems</a> API operation. In this case, compliance data isn't managed
/// by State Manager, a capability of Amazon Web Services Systems Manager. It is managed
/// by your direct call to the <a>PutComplianceItems</a> API operation.
/// by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by
/// your direct call to the <a>PutComplianceItems</a> API operation.
/// </para>
///
/// <para>
Expand Down
Loading

0 comments on commit 6828950

Please sign in to comment.