Data retrieval APIs for AWS Systems Manager
AWS Systems Manager provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeActivations | View details about a specified managed instance activation, such as when it was created and the number of instances registered using the activation | Read |
| DescribeAssociation | View details about the specified association for a specified instance or target | Read |
| DescribeAssociationExecutionTargets | View information about a specified association execution | Read |
| DescribeAssociationExecutions | View all executions for a specified association | Read |
| DescribeAutomationExecutions | View details about all active and terminated Automation executions | Read |
| DescribeAutomationStepExecutions | View information about all active and terminated step executions in an Automation workflow | Read |
| DescribeAvailablePatches | View all patches eligible to include in a patch baseline | Read |
| DescribeDocument | View details about a specified SSM document | Read |
| DescribeDocumentParameters | Display information about SSM document parameters in the Systems Manager console (internal Systems Manager action) | Read |
| DescribeDocumentPermission | View the permissions for a specified SSM document | Read |
| DescribeEffectiveInstanceAssociations | View all current associations for a specified instance | Read |
| DescribeEffectivePatchesForPatchBaseline | View details about the patches currently associated with the specified patch baseline (Windows only) | Read |
| DescribeInstanceAssociationsStatus | View the status of the associations for a specified instance | Read |
| DescribeInstanceInformation | View details about a specified instance | Read |
| DescribeInstancePatchStates | View status details about patches on a specified instance | Read |
| DescribeInstancePatchStatesForPatchGroup | Describe the high-level patch state for the instances in the specified patch group | Read |
| DescribeInstancePatches | View general details about the patches on a specified instance | Read |
| DescribeInstanceProperties | User's Amazon EC2 console to render managed instances' nodes | Read |
| DescribeInventoryDeletions | View details about a specified inventory deletion | Read |
| DescribeMaintenanceWindowExecutionTaskInvocations | View details of a specified task execution for a maintenance window | List |
| DescribeMaintenanceWindowExecutionTasks | View details about the tasks that ran during a specified maintenance window execution | List |
| DescribeMaintenanceWindowExecutions | View the executions of a specified maintenance window | List |
| DescribeMaintenanceWindowSchedule | View details about upcoming executions of a specified maintenance window | List |
| DescribeMaintenanceWindowTargets | View a list of the targets associated with a specified maintenance window | List |
| DescribeMaintenanceWindowTasks | View a list of the tasks associated with a specified maintenance window | List |
| DescribeMaintenanceWindows | View information about all or specified maintenance windows | List |
| DescribeMaintenanceWindowsForTarget | View information about the maintenance window targets and tasks associated with a specified instance | List |
| DescribeOpsItems | View details about specified OpsItems | Read |
| DescribeParameters | View details about a specified SSM parameter | List |
| DescribePatchBaselines | View information about patch baselines that meet the specified criteria | List |
| DescribePatchGroupState | View aggregated status details for patches for a specified patch group | List |
| DescribePatchGroups | View information about the patch baseline for a specified patch group | List |
| DescribePatchProperties | View details of available patches for a specified operating system and patch property | List |
| DescribeSessions | View a list of recent Session Manager sessions that meet the specified search criteria | List |
| ExecuteAPI | A Systems Manager delegated administrator to view related resource details about OpsItems across multiple AWS accounts in the AWS Management Console | Read |
| GetAccessToken | Return a credentials set to be used with just-in-time node access | Read |
| GetAutomationExecution | View details of a specified Automation execution | Read |
| GetCalendar | View details of a specific calendar | Read |
| GetCalendarState | View the calendar state for a change calendar or a list of change calendars | Read |
| GetCommandInvocation | View details about the command execution of a specified invocation or plugin | Read |
| GetConnectionStatus | View the Session Manager connection status for a specified managed instance | Read |
| GetDefaultPatchBaseline | View the current default patch baseline for a specified operating system type | Read |
| GetDeployablePatchSnapshotForInstance | Retrieve the current patch baseline snapshot for a specified instance | Read |
| GetDocument | View the contents of a specified SSM document | Read |
| GetExecutionPreview | Retrieve an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources | Read |
| GetInventory | View instance inventory details per the specified criteria | Read |
| GetInventorySchema | View a list of inventory types or attribute names for a specified inventory item type | Read |
| GetMaintenanceWindow | View details about a specified maintenance window | Read |
| GetMaintenanceWindowExecution | View details about a specified maintenance window execution | Read |
| GetMaintenanceWindowExecutionTask | View details about a specified maintenance window execution task | Read |
| GetMaintenanceWindowExecutionTaskInvocation | View details about a specific maintenance window task running on a specific target | Read |
| GetMaintenanceWindowTask | View details about tasks registered with a specified maintenance window | Read |
| GetManifest | Systems Manager and SSM Agent to determine package installation requirements for an instance (internal Systems Manager call) | Read |
| GetOpsItem | View information about a specified OpsItem | Read |
| GetOpsMetadata | Retrieve an OpsMetadata object | Read |
| GetOpsSummary | View summary information about OpsItems based on specified filters and aggregators | Read |
| GetParameter | View information about a specified parameter | Read |
| GetParameterHistory | View details and changes for a specified parameter | Read |
| GetParameters | View information about multiple specified parameters | Read |
| GetParametersByPath | View information about parameters in a specified hierarchy | Read |
| GetPatchBaseline | View information about a specified patch baseline | Read |
| GetPatchBaselineForPatchGroup | View the ID of the current patch baseline for a specified patch group | Read |
| GetResourcePolicies | Retrieve lists of Systems Manager resource policies | List |
| GetServiceSetting | View the account-level setting for an AWS service | Read |
| ListAssociationVersions | List versions of the specified association | List |
| ListAssociations | List the associations for a specified SSM document or managed instance | List |
| ListCommandInvocations | List information about command invocations sent to a specified instance | List |
| ListCommands | List the commands sent to a specified instance | List |
| ListComplianceItems | List compliance status for specified resource types on a specified resource | List |
| ListComplianceSummaries | List a summary count of compliant and noncompliant resources for a specified compliance type | List |
| ListDocumentMetadataHistory | View metadata history about a specified SSM document | List |
| ListDocumentVersions | List all versions of a specified document | List |
| ListDocuments | View information about a specified SSM document | List |
| ListInstanceAssociations | SSM Agent to check for new State Manager associations (internal Systems Manager call) | List |
| ListInventoryEntries | View a list of specified inventory types for a specified instance | List |
| ListNodes | View details about managed nodes based on specified filters | List |
| ListNodesSummary | View summary information about managed nodes based on specified filters and aggregators | List |
| ListOpsItemEvents | View details about OpsItemEvents | List |
| ListOpsItemRelatedItems | View details about OpsItem RelatedItems | List |
| ListOpsMetadata | View a list of OpsMetadata objects | List |
| ListResourceComplianceSummaries | List resource-level summary count | List |
| ListResourceDataSync | List information about resource data sync configurations in an account | List |
| ListTagsForResource | View a list of resource tags for a specified resource | List |
| PutConfigurePackageResult | SSM Agent to generate a report of the results of specific agent requests (internal Systems Manager call) | Read |
| StartExecutionPreview | Create a preview showing the effects that running a specified Automation runbook would have on the targeted resources | Read |
