SsmClient
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
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference.
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference.
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference.
Functions
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:
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.
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.
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.
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 Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
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.
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
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.
Creates a new maintenance window.
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
Creates a patch baseline.
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID.
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
Deletes a maintenance window.
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Delete OpsMetadata related to an application.
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
Deletes a patch baseline.
Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
Removes a patch group from a patch baseline.
Removes a target from a maintenance window.
Removes a task from a maintenance window.
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.
Views all executions for a specific association ID.
Views information about a specific execution of a specific association.
Provides details about all active and terminated Automation executions.
Information about all active and terminated step executions in an Automation workflow.
Lists all patches eligible to be included in a patch baseline.
Describes the specified Amazon Web Services Systems Manager document (SSM document).
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
All associations for the managed node(s).
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
The status of the associations for the managed node(s).
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
Retrieves the high-level patch state of one or more managed nodes.
Retrieves the high-level patch state for the managed nodes in the specified patch group.
Describes a specific delete inventory operation.
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
For a given maintenance window execution, lists the tasks that were run.
Retrieves the maintenance windows in an Amazon Web Services account.
Retrieves information about upcoming executions of a maintenance window.
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
Lists the targets registered with the maintenance window.
Lists the tasks in a maintenance window.
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
Lists the patch baselines in your Amazon Web Services account.
Lists all patch groups that have been registered with patch baselines.
Returns high-level aggregated patch compliance state information for a patch group.
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.
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
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.
Get detailed information about a particular Automation execution.
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.
Returns detailed information about command execution for an invocation or plugin.
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
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.
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).
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
Query inventory information. This includes managed node status, such as Stopped or Terminated.
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
Retrieves a maintenance window.
Retrieves details about a specific a maintenance window execution.
Retrieves the details about a specific task run as part of a maintenance window execution.
Retrieves information about a specific task running on a specific target.
Retrieves the details of a maintenance window task.
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
View operational metadata related to an application in Application Manager.
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
Get information about a single parameter by specifying the parameter name.
Retrieves the history of all changes to a parameter.
Get information about one or more parameters by specifying multiple parameter names.
Retrieve information about one or more parameters in a specific hierarchy.
Retrieves information about a patch baseline.
Retrieves the patch baseline that should be used for the specified patch group.
Returns an array of the Policy object.
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.
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.
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.
Retrieves all versions of an association for a specific association ID.
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.
Lists the commands requested by users of the Amazon Web Services account.
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.
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
Information about approval reviews for a version of a change template in Change Manager.
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
List all versions for a document.
A list of inventory items returned by the request.
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.
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
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.
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.
Returns a list of the tags assigned to the specified resource.
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
Add a parameter to the system.
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
Defines the default patch baseline for the relevant operating system.
Registers a patch baseline for a patch group.
Registers a target with a maintenance window.
Adds a new task to a maintenance window.
Removes tag keys from the specified resource.
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.
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
Sends a signal to an Automation execution to change the current behavior or status of the execution.
Runs commands on one or more managed nodes.
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
Initiates execution of an Automation runbook.
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Stop an Automation that is currently running.
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
Remove a label or labels from a parameter.
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
Updates one or more values for an SSM document.
Set the default version of a document.
Updates information related to approval reviews for a specific version of a change template in Change Manager.
Updates an existing maintenance window. Only specified parameters are modified.
Modifies the target of an existing maintenance window. You can change the following:
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
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.
Inherited functions
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:
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.
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.
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.
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 Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.
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.
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
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.
Creates a new maintenance window.
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
Creates a patch baseline.
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID.
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
Deletes a maintenance window.
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Delete OpsMetadata related to an application.
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
Deletes a patch baseline.
Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
Removes a patch group from a patch baseline.
Removes a target from a maintenance window.
Removes a task from a maintenance window.
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
Paginate over DescribeActivationsResponse results.
Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.
Views all executions for a specific association ID.
Paginate over DescribeAssociationExecutionsResponse results.
Views information about a specific execution of a specific association.
Paginate over DescribeAssociationExecutionTargetsResponse results.
Provides details about all active and terminated Automation executions.
Paginate over DescribeAutomationExecutionsResponse results.
Information about all active and terminated step executions in an Automation workflow.
Paginate over DescribeAutomationStepExecutionsResponse results.
Lists all patches eligible to be included in a patch baseline.
Paginate over DescribeAvailablePatchesResponse results.
Describes the specified Amazon Web Services Systems Manager document (SSM document).
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
All associations for the managed node(s).
Paginate over DescribeEffectiveInstanceAssociationsResponse results.
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
Paginate over DescribeEffectivePatchesForPatchBaselineResponse results.
The status of the associations for the managed node(s).
Paginate over DescribeInstanceAssociationsStatusResponse results.
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
Paginate over DescribeInstanceInformationResponse results.
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
Paginate over DescribeInstancePatchesResponse results.
Retrieves the high-level patch state of one or more managed nodes.
Retrieves the high-level patch state for the managed nodes in the specified patch group.
Paginate over DescribeInstancePatchStatesForPatchGroupResponse results.
Paginate over DescribeInstancePatchStatesResponse results.
Describes a specific delete inventory operation.
Paginate over DescribeInventoryDeletionsResponse results.
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
Paginate over DescribeMaintenanceWindowExecutionsResponse results.
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
Paginate over DescribeMaintenanceWindowExecutionTaskInvocationsResponse results.
For a given maintenance window execution, lists the tasks that were run.
Paginate over DescribeMaintenanceWindowExecutionTasksResponse results.
Retrieves the maintenance windows in an Amazon Web Services account.
Retrieves information about upcoming executions of a maintenance window.
Paginate over DescribeMaintenanceWindowScheduleResponse results.
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
Paginate over DescribeMaintenanceWindowsForTargetResponse results.
Paginate over DescribeMaintenanceWindowsResponse results.
Lists the targets registered with the maintenance window.
Paginate over DescribeMaintenanceWindowTargetsResponse results.
Lists the tasks in a maintenance window.
Paginate over DescribeMaintenanceWindowTasksResponse results.
Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Paginate over DescribeOpsItemsResponse results.
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
Paginate over DescribeParametersResponse results.
Lists the patch baselines in your Amazon Web Services account.
Paginate over DescribePatchBaselinesResponse results.
Lists all patch groups that have been registered with patch baselines.
Paginate over DescribePatchGroupsResponse results.
Returns high-level aggregated patch compliance state information for a patch group.
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.
Paginate over DescribePatchPropertiesResponse results.
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
Paginate over DescribeSessionsResponse results.
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.
Get detailed information about a particular Automation execution.
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.
Returns detailed information about command execution for an invocation or plugin.
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
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.
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).
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
Query inventory information. This includes managed node status, such as Stopped or Terminated.
Paginate over GetInventoryResponse results.
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
Paginate over GetInventorySchemaResponse results.
Retrieves a maintenance window.
Retrieves details about a specific a maintenance window execution.
Retrieves the details about a specific task run as part of a maintenance window execution.
Retrieves information about a specific task running on a specific target.
Retrieves the details of a maintenance window task.
Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
View operational metadata related to an application in Application Manager.
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
Paginate over GetOpsSummaryResponse results.
Get information about a single parameter by specifying the parameter name.
Retrieves the history of all changes to a parameter.
Paginate over GetParameterHistoryResponse results.
Get information about one or more parameters by specifying multiple parameter names.
Retrieve information about one or more parameters in a specific hierarchy.
Paginate over GetParametersByPathResponse results.
Retrieves information about a patch baseline.
Retrieves the patch baseline that should be used for the specified patch group.
Returns an array of the Policy object.
Paginate over GetResourcePoliciesResponse results.
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.
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.
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.
Paginate over ListAssociationsResponse results.
Retrieves all versions of an association for a specific association ID.
Paginate over ListAssociationVersionsResponse results.
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.
Paginate over ListCommandInvocationsResponse results.
Lists the commands requested by users of the Amazon Web Services account.
Paginate over ListCommandsResponse results.
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.
Paginate over ListComplianceItemsResponse results.
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
Paginate over ListComplianceSummariesResponse results.
Information about approval reviews for a version of a change template in Change Manager.
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
Paginate over ListDocumentsResponse results.
List all versions for a document.
Paginate over ListDocumentVersionsResponse results.
A list of inventory items returned by the request.
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.
Paginate over ListOpsItemEventsResponse results.
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
Paginate over ListOpsItemRelatedItemsResponse results.
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
Paginate over ListOpsMetadataResponse results.
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.
Paginate over ListResourceComplianceSummariesResponse results.
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.
Paginate over ListResourceDataSyncResponse results.
Returns a list of the tags assigned to the specified resource.
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
Add a parameter to the system.
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
Defines the default patch baseline for the relevant operating system.
Registers a patch baseline for a patch group.
Registers a target with a maintenance window.
Adds a new task to a maintenance window.
Removes tag keys from the specified resource.
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.
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
Sends a signal to an Automation execution to change the current behavior or status of the execution.
Runs commands on one or more managed nodes.
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
Initiates execution of an Automation runbook.
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Stop an Automation that is currently running.
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.
Remove a label or labels from a parameter.
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
Updates one or more values for an SSM document.
Set the default version of a document.
Updates information related to approval reviews for a specific version of a change template in Change Manager.
Updates an existing maintenance window. Only specified parameters are modified.
Modifies the target of an existing maintenance window. You can change the following:
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
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.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.