From 6828950508a88f14770230054cf9d525b1e4b9b1 Mon Sep 17 00:00:00 2001 From: aws-sdk-dotnet-automation Date: Fri, 24 Jan 2025 19:21:49 +0000 Subject: [PATCH] Systems Manager doc-only update for January, 2025. --- .../ssm/ssm-2014-11-06.docs.json | 62 +++++----- .../ssm/ssm-2014-11-06.normal.json | 62 +++++----- .../AssociateOpsItemRelatedItemRequest.cs | 2 +- .../Generated/Model/AssociationDescription.cs | 6 +- .../Generated/Model/AssociationVersionInfo.cs | 4 +- .../Generated/Model/Command.cs | 4 +- .../Generated/Model/CommandInvocation.cs | 4 +- .../Model/CreateActivationRequest.cs | 6 +- .../CreateAssociationBatchRequestEntry.cs | 6 +- .../Model/CreateAssociationRequest.cs | 14 +-- .../Model/DescribePatchGroupStateResponse.cs | 4 +- .../DisassociateOpsItemRelatedItemRequest.cs | 2 +- .../Model/GetCalendarStateRequest.cs | 2 +- ...ployablePatchSnapshotForInstanceRequest.cs | 6 +- .../Model/GetParametersByPathRequest.cs | 3 +- .../Generated/Model/InstancePatchState.cs | 4 +- .../Model/ListAssociationsRequest.cs | 4 +- .../Model/ListOpsItemRelatedItemsRequest.cs | 2 +- .../Generated/Model/ParameterInlinePolicy.cs | 2 +- .../Generated/Model/PutParameterRequest.cs | 7 +- .../Generated/Model/SendCommandRequest.cs | 2 +- .../Model/StartAutomationExecutionRequest.cs | 5 +- .../StartChangeRequestExecutionRequest.cs | 9 +- .../Generated/Model/StartSessionRequest.cs | 3 + .../Generated/Model/Target.cs | 2 +- .../Model/UpdateAssociationRequest.cs | 8 +- .../AmazonSimpleSystemsManagementClient.cs | 64 +++++----- .../_bcl35/IAmazonSimpleSystemsManagement.cs | 64 +++++----- .../AmazonSimpleSystemsManagementClient.cs | 115 +++++++++--------- .../_bcl45/IAmazonSimpleSystemsManagement.cs | 115 +++++++++--------- .../AmazonSimpleSystemsManagementClient.cs | 64 +++++----- .../IAmazonSimpleSystemsManagement.cs | 64 +++++----- 32 files changed, 369 insertions(+), 352 deletions(-) diff --git a/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json b/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json index 7b2f6e76e67e..d331c1a05b8b 100644 --- a/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json +++ b/generator/ServiceModels/ssm/ssm-2014-11-06.docs.json @@ -1,13 +1,13 @@ { "version": "2.0", - "service": "

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

Related resources

", + "service": "

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

Related resources

", "operations": { "AddTagsToResource": "

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:

Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.

For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

", - "AssociateOpsItemRelatedItem": "

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.

", + "AssociateOpsItemRelatedItem": "

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 tools in Amazon Web Services Systems Manager.

", "CancelCommand": "

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

", "CancelMaintenanceWindowExecution": "

Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.

", - "CreateActivation": "

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 Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

", - "CreateAssociation": "

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed 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.

", + "CreateActivation": "

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 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 Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

", + "CreateAssociation": "

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed 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 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.

", "CreateAssociationBatch": "

Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.

When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.

If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.

", "CreateDocument": "

Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.

", "CreateMaintenanceWindow": "

Creates a new maintenance window.

The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

", @@ -64,13 +64,13 @@ "DescribePatchGroups": "

Lists all patch groups that have been registered with patch baselines.

", "DescribePatchProperties": "

Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

The following section lists the properties that can be used in filters for each major operating system type:

AMAZON_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

AMAZON_LINUX_2

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

AMAZON_LINUX_2023

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

CENTOS

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

DEBIAN

Valid properties: PRODUCT | PRIORITY

MACOS

Valid properties: PRODUCT | CLASSIFICATION

ORACLE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

REDHAT_ENTERPRISE_LINUX

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

SUSE

Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

UBUNTU

Valid properties: PRODUCT | PRIORITY

WINDOWS

Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY

", "DescribeSessions": "

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

", - "DisassociateOpsItemRelatedItem": "

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.

", + "DisassociateOpsItemRelatedItem": "

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 tool in Amazon Web Services Systems Manager.

", "GetAutomationExecution": "

Get detailed information about a particular Automation execution.

", - "GetCalendarState": "

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

", + "GetCalendarState": "

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a tool in Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

", "GetCommandInvocation": "

Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.

GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

", "GetConnectionStatus": "

Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

", "GetDefaultPatchBaseline": "

Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

If you don't specify an operating system value, the default patch baseline for Windows is returned.

", - "GetDeployablePatchSnapshotForInstance": "

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

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 AWS-RunShellScript document or the AWS-RunPowerShellScript document.

", + "GetDeployablePatchSnapshotForInstance": "

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

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 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 AWS-RunShellScript document or the AWS-RunPowerShellScript document.

", "GetDocument": "

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

", "GetExecutionPreview": "

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

", "GetInventory": "

Query inventory information. This includes managed node status, such as Stopped or Terminated.

", @@ -86,14 +86,14 @@ "GetParameter": "

Get information about a single parameter by specifying the parameter name.

To get information about more than one parameter at a time, use the GetParameters operation.

", "GetParameterHistory": "

Retrieves the history of all changes to a parameter.

If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, GetParameterHistory retrieves whatever the original key alias was referencing.

", "GetParameters": "

Get information about one or more parameters by specifying multiple parameter names.

To get information about a single parameter, you can use the GetParameter operation instead.

", - "GetParametersByPath": "

Retrieve information about one or more parameters in a specific hierarchy.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

", + "GetParametersByPath": "

Retrieve information about one or more parameters under a specified level in a hierarchy.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

", "GetPatchBaseline": "

Retrieves information about a patch baseline.

", "GetPatchBaselineForPatchGroup": "

Retrieves the patch baseline that should be used for the specified patch group.

", "GetResourcePolicies": "

Returns an array of the Policy object.

", "GetServiceSetting": "

ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.

Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

Query the current service setting for the Amazon Web Services account.

", "LabelParameterVersion": "

A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

Parameter labels have the following requirements and restrictions.

", "ListAssociationVersions": "

Retrieves all versions of an association for a specific association ID.

", - "ListAssociations": "

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.

", + "ListAssociations": "

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 tool in Amazon Web Services Systems Manager.

", "ListCommandInvocations": "

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

", "ListCommands": "

Lists the commands requested by users of the Amazon Web Services account.

", "ListComplianceItems": "

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

", @@ -105,7 +105,7 @@ "ListNodes": "

Takes in filters and returns a list of managed nodes matching the filter criteria.

", "ListNodesSummary": "

Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.

", "ListOpsItemEvents": "

Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.

", - "ListOpsItemRelatedItems": "

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.

", + "ListOpsItemRelatedItems": "

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.

", "ListOpsMetadata": "

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

", "ListResourceComplianceSummaries": "

Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

", "ListResourceDataSync": "

Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

", @@ -613,11 +613,11 @@ "AssociationSyncCompliance": { "base": null, "refs": { - "AssociationDescription$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

", - "AssociationVersionInfo$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

", - "CreateAssociationBatchRequestEntry$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

", + "AssociationDescription$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

", + "AssociationVersionInfo$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

", + "CreateAssociationBatchRequestEntry$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

", "CreateAssociationRequest$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

", - "UpdateAssociationRequest$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

" + "UpdateAssociationRequest$SyncCompliance": "

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

" } }, "AssociationVersion": { @@ -930,10 +930,10 @@ "AutomationTargetParameterName": { "base": null, "refs": { - "AssociationDescription$AutomationTargetParameterName": "

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.

", - "CreateAssociationBatchRequestEntry$AutomationTargetParameterName": "

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.

", - "CreateAssociationRequest$AutomationTargetParameterName": "

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.

", - "UpdateAssociationRequest$AutomationTargetParameterName": "

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.

" + "AssociationDescription$AutomationTargetParameterName": "

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 tool in Amazon Web Services Systems Manager.

", + "CreateAssociationBatchRequestEntry$AutomationTargetParameterName": "

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 tool in Amazon Web Services Systems Manager.

", + "CreateAssociationRequest$AutomationTargetParameterName": "

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 tool in Amazon Web Services Systems Manager.

", + "UpdateAssociationRequest$AutomationTargetParameterName": "

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 tool in Amazon Web Services Systems Manager.

" } }, "AutomationType": { @@ -1131,7 +1131,7 @@ "CommandInvocation$CloudWatchOutputConfig": "

Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.

", "GetCommandInvocationResult$CloudWatchOutputConfig": "

Amazon CloudWatch Logs information where Systems Manager sent the command output.

", "MaintenanceWindowRunCommandParameters$CloudWatchOutputConfig": null, - "SendCommandRequest$CloudWatchOutputConfig": "

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.

" + "SendCommandRequest$CloudWatchOutputConfig": "

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in Amazon Web Services Systems Manager.

" } }, "CloudWatchOutputEnabled": { @@ -3575,7 +3575,7 @@ "DescribePatchGroupStateResult$InstancesWithMissingPatches": "

The number of managed nodes with missing patches from the patch baseline.

", "DescribePatchGroupStateResult$InstancesWithFailedPatches": "

The number of managed nodes with patches from the patch baseline that failed to install.

", "DescribePatchGroupStateResult$InstancesWithNotApplicablePatches": "

The number of managed nodes with patches that aren't applicable.

", - "DescribePatchGroupStateResult$InstancesWithUnreportedNotApplicablePatches": "

The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

", + "DescribePatchGroupStateResult$InstancesWithUnreportedNotApplicablePatches": "

The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.

", "OpsItemLimitExceededException$Limit": null, "ParentStepDetails$Iteration": "

The current repetition of the loop represented by an integer.

", "ProgressCounters$TotalSteps": "

The total number of steps run in all specified Amazon Web Services Regions and Amazon Web Services accounts for the current Automation execution.

", @@ -6153,7 +6153,7 @@ "refs": { "Parameter$Value": "

The parameter value.

If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

", "ParameterHistory$Value": "

The parameter value.

", - "PutParameterRequest$Value": "

The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

" + "PutParameterRequest$Value": "

The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets {{}} or {{ssm:parameter-name}} in a parameter value.

" } }, "PSParameterVersion": { @@ -6298,7 +6298,7 @@ "ParameterPolicies": { "base": null, "refs": { - "PutParameterRequest$Policies": "

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:

Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

" + "PutParameterRequest$Policies": "

One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:

Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

" } }, "ParameterPolicyList": { @@ -6396,7 +6396,7 @@ "CreateAssociationRequest$Parameters": "

The parameters for the runtime configuration of the document.

", "MaintenanceWindowRunCommandParameters$Parameters": "

The parameters for the RUN_COMMAND task execution.

", "SendCommandRequest$Parameters": "

The required and optional parameters specified in the document being run.

", - "UpdateAssociationRequest$Parameters": "

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 the parameter using {{ssm:parameter-name}}.

" + "UpdateAssociationRequest$Parameters": "

The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

" } }, "ParametersFilter": { @@ -6964,7 +6964,7 @@ "PatchUnreportedNotApplicableCount": { "base": null, "refs": { - "InstancePatchState$UnreportedNotApplicableCount": "

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

" + "InstancePatchState$UnreportedNotApplicableCount": "

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.

" } }, "PatchVendor": { @@ -7743,8 +7743,8 @@ "ServiceRole": { "base": null, "refs": { - "Command$ServiceRole": "

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 about command status changes.

", - "CommandInvocation$ServiceRole": "

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 about command status changes on a per managed node basis.

", + "Command$ServiceRole": "

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.

", + "CommandInvocation$ServiceRole": "

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.

", "GetMaintenanceWindowExecutionTaskResult$ServiceRole": "

The role that was assumed when running the task.

", "GetMaintenanceWindowTaskResult$ServiceRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

", "MaintenanceWindowRunCommandParameters$ServiceRoleArn": "

The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

", @@ -7869,7 +7869,7 @@ "SessionManagerParameters": { "base": null, "refs": { - "StartSessionRequest$Parameters": "

The values you want to specify for the parameters defined in the Session document.

" + "StartSessionRequest$Parameters": "

The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see Create a Session Manager preferences document in the Amazon Web Services Systems Manager User Guide.

" } }, "SessionManagerS3OutputUrl": { @@ -8288,7 +8288,7 @@ "ParameterAlreadyExists$message": null, "ParameterHistory$LastModifiedUser": "

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

", "ParameterInlinePolicy$PolicyText": "

The JSON text of the policy.

", - "ParameterInlinePolicy$PolicyType": "

The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

", + "ParameterInlinePolicy$PolicyType": "

The type of policy. Parameter Store, a tool in Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

", "ParameterInlinePolicy$PolicyStatus": "

The status of the policy. Policies report the following statuses: Pending (the policy hasn't been enforced or applied yet), Finished (the policy was applied), Failed (the policy wasn't applied), or InProgress (the policy is being applied now).

", "ParameterLimitExceeded$message": null, "ParameterMaxVersionLimitExceeded$message": null, @@ -8394,8 +8394,8 @@ "DocumentIdentifier$Tags": "

The tags, or metadata, that have been applied to the document.

", "ListTagsForResourceResult$TagList": "

A list of tags.

", "PutParameterRequest$Tags": "

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:

To add tags to an existing Systems Manager parameter, use the AddTagsToResource operation.

", - "StartAutomationExecutionRequest$Tags": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

To add tags to an existing automation, use the AddTagsToResource operation.

", - "StartChangeRequestExecutionRequest$Tags": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

" + "StartAutomationExecutionRequest$Tags": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartAutomationExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing automation configuration.

", + "StartChangeRequestExecutionRequest$Tags": "

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

" } }, "TagValue": { @@ -8405,7 +8405,7 @@ } }, "Target": { - "base": "

An array of search criteria that targets managed nodes using a key-value pair that you specify.

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Supported formats include the following.

For all Systems Manager capabilities:

For Automation and Change Manager:

For Run Command and Maintenance Windows:

For State Manager:

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

", + "base": "

An array of search criteria that targets managed nodes using a key-value pair that you specify.

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Supported formats include the following.

For all Systems Manager tools:

For Automation and Change Manager:

For Run Command and Maintenance Windows:

For State Manager:

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

", "refs": { "Targets$member": null } diff --git a/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json b/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json index de7db8a04423..bcbff684a553 100644 --- a/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json +++ b/generator/ServiceModels/ssm/ssm-2014-11-06.normal.json @@ -48,7 +48,7 @@ {"shape":"OpsItemRelatedItemAlreadyExistsException"}, {"shape":"OpsItemConflictException"} ], - "documentation":"

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.

" + "documentation":"

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 tools in Amazon Web Services Systems Manager.

" }, "CancelCommand":{ "name":"CancelCommand", @@ -92,7 +92,7 @@ {"shape":"InvalidParameters"}, {"shape":"InternalServerError"} ], - "documentation":"

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 Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

" + "documentation":"

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 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 Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

" }, "CreateAssociation":{ "name":"CreateAssociation", @@ -117,7 +117,7 @@ {"shape":"InvalidTargetMaps"}, {"shape":"InvalidTag"} ], - "documentation":"

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed 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.

" + "documentation":"

A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed 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 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.

" }, "CreateAssociationBatch":{ "name":"CreateAssociationBatch", @@ -985,7 +985,7 @@ {"shape":"OpsItemInvalidParameterException"}, {"shape":"OpsItemConflictException"} ], - "documentation":"

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.

" + "documentation":"

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 tool in Amazon Web Services Systems Manager.

" }, "GetAutomationExecution":{ "name":"GetAutomationExecution", @@ -1015,7 +1015,7 @@ {"shape":"InvalidDocumentType"}, {"shape":"UnsupportedCalendarException"} ], - "documentation":"

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

" + "documentation":"

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a tool in Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

" }, "GetCommandInvocation":{ "name":"GetCommandInvocation", @@ -1073,7 +1073,7 @@ {"shape":"UnsupportedOperatingSystem"}, {"shape":"UnsupportedFeatureRequiredException"} ], - "documentation":"

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

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 AWS-RunShellScript document or the AWS-RunPowerShellScript document.

" + "documentation":"

Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

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 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 AWS-RunShellScript document or the AWS-RunPowerShellScript document.

" }, "GetDocument":{ "name":"GetDocument", @@ -1318,7 +1318,7 @@ {"shape":"InvalidKeyId"}, {"shape":"InvalidNextToken"} ], - "documentation":"

Retrieve information about one or more parameters in a specific hierarchy.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

" + "documentation":"

Retrieve information about one or more parameters under a specified level in a hierarchy.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

" }, "GetPatchBaseline":{ "name":"GetPatchBaseline", @@ -1421,7 +1421,7 @@ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], - "documentation":"

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.

" + "documentation":"

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 tool in Amazon Web Services Systems Manager.

" }, "ListCommandInvocations":{ "name":"ListCommandInvocations", @@ -1615,7 +1615,7 @@ {"shape":"InternalServerError"}, {"shape":"OpsItemInvalidParameterException"} ], - "documentation":"

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.

" + "documentation":"

Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a tool in Amazon Web Services Systems Manager.

" }, "ListOpsMetadata":{ "name":"ListOpsMetadata", @@ -2675,7 +2675,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"

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.

" + "documentation":"

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 tool in Amazon Web Services Systems Manager.

" }, "Parameters":{ "shape":"Parameters", @@ -2723,7 +2723,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

" + "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -3161,7 +3161,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

" + "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -4068,7 +4068,7 @@ }, "ServiceRole":{ "shape":"ServiceRole", - "documentation":"

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 about command status changes.

" + "documentation":"

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.

" }, "NotificationConfig":{ "shape":"NotificationConfig", @@ -4194,7 +4194,7 @@ }, "ServiceRole":{ "shape":"ServiceRole", - "documentation":"

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 about command status changes on a per managed node basis.

" + "documentation":"

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.

" }, "NotificationConfig":{ "shape":"NotificationConfig", @@ -4684,7 +4684,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"

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.

" + "documentation":"

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 tool in Amazon Web Services Systems Manager.

" }, "DocumentVersion":{ "shape":"DocumentVersion", @@ -4720,7 +4720,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

" + "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -4804,7 +4804,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"

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.

" + "documentation":"

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 tool in Amazon Web Services Systems Manager.

" }, "MaxErrors":{ "shape":"MaxErrors", @@ -6685,7 +6685,7 @@ }, "InstancesWithUnreportedNotApplicablePatches":{ "shape":"Integer", - "documentation":"

The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

", + "documentation":"

The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.

", "box":true }, "InstancesWithCriticalNonCompliantPatches":{ @@ -9355,7 +9355,7 @@ }, "UnreportedNotApplicableCount":{ "shape":"PatchUnreportedNotApplicableCount", - "documentation":"

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

", + "documentation":"

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.

", "box":true }, "NotApplicableCount":{ @@ -13540,7 +13540,7 @@ }, "PolicyType":{ "shape":"String", - "documentation":"

The type of policy. Parameter Store, a capability of Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

" + "documentation":"

The type of policy. Parameter Store, a tool in Amazon Web Services Systems Manager, supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

" }, "PolicyStatus":{ "shape":"String", @@ -14563,7 +14563,7 @@ }, "Value":{ "shape":"PSParameterValue", - "documentation":"

The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

Parameters can't be referenced or nested in the values of other parameters. You can't include {{}} or {{ssm:parameter-name}} in a parameter value.

" + "documentation":"

The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets {{}} or {{ssm:parameter-name}} in a parameter value.

" }, "Type":{ "shape":"ParameterType", @@ -14592,7 +14592,7 @@ }, "Policies":{ "shape":"ParameterPolicies", - "documentation":"

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:

Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

" + "documentation":"

One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:

Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.

All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Assigning parameter policies.

" }, "DataType":{ "shape":"ParameterDataType", @@ -15729,7 +15729,7 @@ }, "CloudWatchOutputConfig":{ "shape":"CloudWatchOutputConfig", - "documentation":"

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.

" + "documentation":"

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a tool in Amazon Web Services Systems Manager.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", @@ -16123,7 +16123,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

To add tags to an existing automation, use the AddTagsToResource operation.

" + "documentation":"

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartAutomationExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing automation configuration.

" }, "AlarmConfiguration":{ "shape":"AlarmConfiguration", @@ -16186,7 +16186,7 @@ }, "Tags":{ "shape":"TagList", - "documentation":"

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

" + "documentation":"

Optional metadata that you assign to a resource. You can specify a maximum of five tags for a change request. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a change request to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

The Array Members maximum value is reported as 1000. This number includes capacity reserved for internal operations. When calling the StartChangeRequestExecution action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource action to add up to a total of 50 tags to an existing change request configuration.

" }, "ScheduledEndTime":{ "shape":"DateTime", @@ -16252,7 +16252,7 @@ }, "Parameters":{ "shape":"SessionManagerParameters", - "documentation":"

The values you want to specify for the parameters defined in the Session document.

" + "documentation":"

The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see Create a Session Manager preferences document in the Amazon Web Services Systems Manager User Guide.

" } } }, @@ -16553,7 +16553,7 @@ "documentation":"

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include EC2 tags of ServerRole,WebServer.

Depending on the type of target, the maximum number of values for a key might be lower than the global maximum of 50.

" } }, - "documentation":"

An array of search criteria that targets managed nodes using a key-value pair that you specify.

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Supported formats include the following.

For all Systems Manager capabilities:

For Automation and Change Manager:

For Run Command and Maintenance Windows:

For State Manager:

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

" + "documentation":"

An array of search criteria that targets managed nodes using a key-value pair that you specify.

One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

Supported formats include the following.

For all Systems Manager tools:

For Automation and Change Manager:

For Run Command and Maintenance Windows:

For State Manager:

For more information about how to send commands that target managed nodes using Key,Value parameters, see Targeting multiple managed nodes in the Amazon Web Services Systems Manager User Guide.

" }, "TargetCount":{"type":"integer"}, "TargetInUseException":{ @@ -16880,7 +16880,7 @@ }, "Parameters":{ "shape":"Parameters", - "documentation":"

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 the parameter using {{ssm:parameter-name}}.

" + "documentation":"

The parameters you want to update for the association. If you create a parameter using Parameter Store, a tool in Amazon Web Services Systems Manager, you can reference the parameter using {{ssm:parameter-name}}.

" }, "DocumentVersion":{ "shape":"DocumentVersion", @@ -16912,7 +16912,7 @@ }, "AutomationTargetParameterName":{ "shape":"AutomationTargetParameterName", - "documentation":"

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.

" + "documentation":"

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 tool in Amazon Web Services Systems Manager.

" }, "MaxErrors":{ "shape":"MaxErrors", @@ -16928,7 +16928,7 @@ }, "SyncCompliance":{ "shape":"AssociationSyncCompliance", - "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems 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 PutComplianceItems API operation.

By default, all associations use AUTO mode.

" + "documentation":"

The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.

In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

" }, "ApplyOnlyAtCronInterval":{ "shape":"ApplyOnlyAtCronInterval", @@ -17749,5 +17749,5 @@ "pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" } }, - "documentation":"

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

Related resources

" + "documentation":"

Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.

Related resources

" } diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociateOpsItemRelatedItemRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociateOpsItemRelatedItemRequest.cs index 8c533dbf455c..c2062c7ef897 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociateOpsItemRelatedItemRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociateOpsItemRelatedItemRequest.cs @@ -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. /// public partial class AssociateOpsItemRelatedItemRequest : AmazonSimpleSystemsManagementRequest { diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationDescription.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationDescription.cs index cb78fdf9d8f0..f8d42e8c2da7 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationDescription.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationDescription.cs @@ -159,7 +159,7 @@ internal bool IsSetAssociationVersion() /// /// 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. /// /// [AWSProperty(Min=1, Max=50)] @@ -546,8 +546,8 @@ internal bool IsSetStatus() /// /// In MANUAL mode, you must specify the AssociationId as a parameter for /// the PutComplianceItems 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 PutComplianceItems API operation. + /// by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by + /// your direct call to the PutComplianceItems API operation. /// /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationVersionInfo.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationVersionInfo.cs index b07677ddbf76..111146f06568 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationVersionInfo.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/AssociationVersionInfo.cs @@ -396,8 +396,8 @@ internal bool IsSetScheduleOffset() /// /// In MANUAL mode, you must specify the AssociationId as a parameter for /// the PutComplianceItems 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 PutComplianceItems API operation. + /// by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by + /// your direct call to the PutComplianceItems API operation. /// /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Command.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Command.cs index 6e725253d383..95aedf0b30f2 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Command.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Command.cs @@ -437,8 +437,8 @@ internal bool IsSetRequestedDateTime() /// /// Gets and sets the property ServiceRole. /// - /// 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. /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CommandInvocation.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CommandInvocation.cs index 8a77ba08fca4..8003860341bd 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CommandInvocation.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CommandInvocation.cs @@ -244,8 +244,8 @@ internal bool IsSetRequestedDateTime() /// /// Gets and sets the property ServiceRole. /// - /// 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. /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateActivationRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateActivationRequest.cs index bda6b4fa5553..8ec577b38ee4 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateActivationRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateActivationRequest.cs @@ -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 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 Using /// Amazon Web Services Systems Manager in hybrid and multicloud environments in the /// Amazon Web Services Systems Manager User Guide. /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationBatchRequestEntry.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationBatchRequestEntry.cs index 04a9dcd30bcd..c9a28c226d97 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationBatchRequestEntry.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationBatchRequestEntry.cs @@ -115,7 +115,7 @@ internal bool IsSetAssociationName() /// /// 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. /// /// [AWSProperty(Min=1, Max=50)] @@ -454,8 +454,8 @@ internal bool IsSetScheduleOffset() /// /// In MANUAL mode, you must specify the AssociationId as a parameter for /// the PutComplianceItems 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 PutComplianceItems API operation. + /// by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by + /// your direct call to the PutComplianceItems API operation. /// /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationRequest.cs index 97f748f76de5..30c075f3c252 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/CreateAssociationRequest.cs @@ -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. /// public partial class CreateAssociationRequest : AmazonSimpleSystemsManagementRequest { @@ -142,7 +142,7 @@ internal bool IsSetAssociationName() /// /// 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. /// /// [AWSProperty(Min=1, Max=50)] diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DescribePatchGroupStateResponse.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DescribePatchGroupStateResponse.cs index a55024931a10..748b4072695d 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DescribePatchGroupStateResponse.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DescribePatchGroupStateResponse.cs @@ -268,8 +268,8 @@ internal bool IsSetInstancesWithSecurityNonCompliantPatches() /// Gets and sets the property InstancesWithUnreportedNotApplicablePatches. /// /// The number of managed nodes with NotApplicable 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. /// /// public int InstancesWithUnreportedNotApplicablePatches diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DisassociateOpsItemRelatedItemRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DisassociateOpsItemRelatedItemRequest.cs index a147b8bc5654..08932ec629ab 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DisassociateOpsItemRelatedItemRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/DisassociateOpsItemRelatedItemRequest.cs @@ -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. /// public partial class DisassociateOpsItemRelatedItemRequest : AmazonSimpleSystemsManagementRequest { diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetCalendarStateRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetCalendarStateRequest.cs index ed5d4050b040..3b4c951f7cd8 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetCalendarStateRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetCalendarStateRequest.cs @@ -46,7 +46,7 @@ namespace Amazon.SimpleSystemsManagement.Model /// /// /// - /// 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 Amazon /// Web Services Systems Manager Change Calendar in the Amazon Web Services Systems /// Manager User Guide. diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetDeployablePatchSnapshotForInstanceRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetDeployablePatchSnapshotForInstanceRequest.cs index 439c1052052d..6d78e9d71ebb 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetDeployablePatchSnapshotForInstanceRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetDeployablePatchSnapshotForInstanceRequest.cs @@ -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 AWS-RunShellScript document or the AWS-RunPowerShellScript + /// 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 AWS-RunShellScript document or the AWS-RunPowerShellScript /// document. /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetParametersByPathRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetParametersByPathRequest.cs index d9dd65a90d8a..533362d8a6f3 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetParametersByPathRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/GetParametersByPathRequest.cs @@ -31,7 +31,8 @@ namespace Amazon.SimpleSystemsManagement.Model { /// /// 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. + /// /// /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/InstancePatchState.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/InstancePatchState.cs index c61926af1c7c..6ba8a12ae55b 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/InstancePatchState.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/InstancePatchState.cs @@ -513,8 +513,8 @@ internal bool IsSetSnapshotId() /// Gets and sets the property UnreportedNotApplicableCount. /// /// The number of patches beyond the supported limit of NotApplicableCount 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. /// /// public int UnreportedNotApplicableCount diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListAssociationsRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListAssociationsRequest.cs index 591ad580d669..0a4c9e3b09b8 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListAssociationsRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListAssociationsRequest.cs @@ -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. /// public partial class ListAssociationsRequest : AmazonSimpleSystemsManagementRequest { diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListOpsItemRelatedItemsRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListOpsItemRelatedItemsRequest.cs index fb293785e144..6f35f2884948 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListOpsItemRelatedItemsRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ListOpsItemRelatedItemsRequest.cs @@ -32,7 +32,7 @@ namespace Amazon.SimpleSystemsManagement.Model /// /// 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. /// public partial class ListOpsItemRelatedItemsRequest : AmazonSimpleSystemsManagementRequest { diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ParameterInlinePolicy.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ParameterInlinePolicy.cs index 9b616d64f9ee..6487abe2afcd 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ParameterInlinePolicy.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/ParameterInlinePolicy.cs @@ -79,7 +79,7 @@ internal bool IsSetPolicyText() /// /// Gets and sets the property PolicyType. /// - /// 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. /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/PutParameterRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/PutParameterRequest.cs index ddb114825bae..a71f8800b04f 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/PutParameterRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/PutParameterRequest.cs @@ -284,8 +284,8 @@ internal bool IsSetOverwrite() /// Gets and sets the property Policies. /// /// 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: /// /// /// @@ -522,7 +522,8 @@ internal bool IsSetType() /// /// /// Parameters can't be referenced or nested in the values of other parameters. You can't - /// include {{}} or {{ssm:parameter-name}} in a parameter value. + /// include values wrapped in double brackets {{}} or {{ssm:parameter-name}} + /// in a parameter value. /// /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/SendCommandRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/SendCommandRequest.cs index f3aace36cf25..57fe9c28936d 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/SendCommandRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/SendCommandRequest.cs @@ -92,7 +92,7 @@ internal bool IsSetAlarmConfiguration() /// Gets and sets the property CloudWatchOutputConfig. /// /// 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. /// /// public CloudWatchOutputConfig CloudWatchOutputConfig diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartAutomationExecutionRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartAutomationExecutionRequest.cs index 900d28cfface..f7a2f6d3ccb9 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartAutomationExecutionRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartAutomationExecutionRequest.cs @@ -249,7 +249,10 @@ internal bool IsSetParameters() /// /// /// - /// To add tags to an existing automation, use the AddTagsToResource operation. + /// The Array Members maximum value is reported as 1000. This number includes capacity + /// reserved for internal operations. When calling the StartAutomationExecution + /// action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource + /// action to add up to a total of 50 tags to an existing automation configuration. /// /// /// diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartChangeRequestExecutionRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartChangeRequestExecutionRequest.cs index cbba5aa7da1b..e51a80eb540e 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartChangeRequestExecutionRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartChangeRequestExecutionRequest.cs @@ -283,7 +283,14 @@ internal bool IsSetScheduledTime() /// /// Key=Region,Value=us-east-2 /// - /// + /// + /// + /// The Array Members maximum value is reported as 1000. This number includes capacity + /// reserved for internal operations. When calling the StartChangeRequestExecution + /// action, you can specify a maximum of 5 tags. You can, however, use the AddTagsToResource + /// action to add up to a total of 50 tags to an existing change request configuration. + /// + /// /// [AWSProperty(Max=1000)] public List Tags diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartSessionRequest.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartSessionRequest.cs index 46f82c70b677..9c04bc24de8e 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartSessionRequest.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/StartSessionRequest.cs @@ -84,6 +84,9 @@ internal bool IsSetDocumentName() /// Gets and sets the property Parameters. /// /// The values you want to specify for the parameters defined in the Session document. + /// For more information about these parameters, see Create + /// a Session Manager preferences document in the Amazon Web Services Systems Manager + /// User Guide. /// /// public Dictionary> Parameters diff --git a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Target.cs b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Target.cs index 77fd90504bb0..70ebee594bb6 100644 --- a/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Target.cs +++ b/sdk/src/Services/SimpleSystemsManagement/Generated/Model/Target.cs @@ -48,7 +48,7 @@ namespace Amazon.SimpleSystemsManagement.Model /// /// /// - /// For all Systems Manager capabilities: + /// For all Systems Manager tools: /// ///