

***
SSM
***



======
Client
======



.. py:class:: SSM.Client

  A low-level client representing Amazon Simple Systems Manager (SSM)
  

  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 <https://docs.aws.amazon.com/systems-manager/latest/userguide/>`__. To get started, see `Setting up Amazon Web Services Systems Manager <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up-console.html>`__.

   

  **Related resources**

   

  
  * For information about each of the tools that comprise Systems Manager, see `Using Systems Manager tools <https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-tools.html>`__ in the *Amazon Web Services Systems Manager User Guide*.
   
  * For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the `Systems Manager Automation Runbook Reference <https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html>`__ .
   
  * For information about AppConfig, a tool in Systems Manager, see the `AppConfig User Guide <https://docs.aws.amazon.com/appconfig/latest/userguide/>`__ and the `AppConfig API Reference <https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/>`__ .
   
  * For information about Incident Manager, a tool in Systems Manager, see the `Systems Manager Incident Manager User Guide <https://docs.aws.amazon.com/incident-manager/latest/userguide/>`__ and the `Systems Manager Incident Manager API Reference <https://docs.aws.amazon.com/incident-manager/latest/APIReference/>`__ .
  

  ::

    
    import boto3
    
    client = boto3.client('ssm')

  

These are the available methods:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  ssm/client/add_tags_to_resource
  ssm/client/associate_ops_item_related_item
  ssm/client/can_paginate
  ssm/client/cancel_command
  ssm/client/cancel_maintenance_window_execution
  ssm/client/close
  ssm/client/create_activation
  ssm/client/create_association
  ssm/client/create_association_batch
  ssm/client/create_document
  ssm/client/create_maintenance_window
  ssm/client/create_ops_item
  ssm/client/create_ops_metadata
  ssm/client/create_patch_baseline
  ssm/client/create_resource_data_sync
  ssm/client/delete_activation
  ssm/client/delete_association
  ssm/client/delete_document
  ssm/client/delete_inventory
  ssm/client/delete_maintenance_window
  ssm/client/delete_ops_item
  ssm/client/delete_ops_metadata
  ssm/client/delete_parameter
  ssm/client/delete_parameters
  ssm/client/delete_patch_baseline
  ssm/client/delete_resource_data_sync
  ssm/client/delete_resource_policy
  ssm/client/deregister_managed_instance
  ssm/client/deregister_patch_baseline_for_patch_group
  ssm/client/deregister_target_from_maintenance_window
  ssm/client/deregister_task_from_maintenance_window
  ssm/client/describe_activations
  ssm/client/describe_association
  ssm/client/describe_association_execution_targets
  ssm/client/describe_association_executions
  ssm/client/describe_automation_executions
  ssm/client/describe_automation_step_executions
  ssm/client/describe_available_patches
  ssm/client/describe_document
  ssm/client/describe_document_permission
  ssm/client/describe_effective_instance_associations
  ssm/client/describe_effective_patches_for_patch_baseline
  ssm/client/describe_instance_associations_status
  ssm/client/describe_instance_information
  ssm/client/describe_instance_patch_states
  ssm/client/describe_instance_patch_states_for_patch_group
  ssm/client/describe_instance_patches
  ssm/client/describe_instance_properties
  ssm/client/describe_inventory_deletions
  ssm/client/describe_maintenance_window_execution_task_invocations
  ssm/client/describe_maintenance_window_execution_tasks
  ssm/client/describe_maintenance_window_executions
  ssm/client/describe_maintenance_window_schedule
  ssm/client/describe_maintenance_window_targets
  ssm/client/describe_maintenance_window_tasks
  ssm/client/describe_maintenance_windows
  ssm/client/describe_maintenance_windows_for_target
  ssm/client/describe_ops_items
  ssm/client/describe_parameters
  ssm/client/describe_patch_baselines
  ssm/client/describe_patch_group_state
  ssm/client/describe_patch_groups
  ssm/client/describe_patch_properties
  ssm/client/describe_sessions
  ssm/client/disassociate_ops_item_related_item
  ssm/client/get_access_token
  ssm/client/get_automation_execution
  ssm/client/get_calendar_state
  ssm/client/get_command_invocation
  ssm/client/get_connection_status
  ssm/client/get_default_patch_baseline
  ssm/client/get_deployable_patch_snapshot_for_instance
  ssm/client/get_document
  ssm/client/get_execution_preview
  ssm/client/get_inventory
  ssm/client/get_inventory_schema
  ssm/client/get_maintenance_window
  ssm/client/get_maintenance_window_execution
  ssm/client/get_maintenance_window_execution_task
  ssm/client/get_maintenance_window_execution_task_invocation
  ssm/client/get_maintenance_window_task
  ssm/client/get_ops_item
  ssm/client/get_ops_metadata
  ssm/client/get_ops_summary
  ssm/client/get_paginator
  ssm/client/get_parameter
  ssm/client/get_parameter_history
  ssm/client/get_parameters
  ssm/client/get_parameters_by_path
  ssm/client/get_patch_baseline
  ssm/client/get_patch_baseline_for_patch_group
  ssm/client/get_resource_policies
  ssm/client/get_service_setting
  ssm/client/get_waiter
  ssm/client/label_parameter_version
  ssm/client/list_association_versions
  ssm/client/list_associations
  ssm/client/list_command_invocations
  ssm/client/list_commands
  ssm/client/list_compliance_items
  ssm/client/list_compliance_summaries
  ssm/client/list_document_metadata_history
  ssm/client/list_document_versions
  ssm/client/list_documents
  ssm/client/list_inventory_entries
  ssm/client/list_nodes
  ssm/client/list_nodes_summary
  ssm/client/list_ops_item_events
  ssm/client/list_ops_item_related_items
  ssm/client/list_ops_metadata
  ssm/client/list_resource_compliance_summaries
  ssm/client/list_resource_data_sync
  ssm/client/list_tags_for_resource
  ssm/client/modify_document_permission
  ssm/client/put_compliance_items
  ssm/client/put_inventory
  ssm/client/put_parameter
  ssm/client/put_resource_policy
  ssm/client/register_default_patch_baseline
  ssm/client/register_patch_baseline_for_patch_group
  ssm/client/register_target_with_maintenance_window
  ssm/client/register_task_with_maintenance_window
  ssm/client/remove_tags_from_resource
  ssm/client/reset_service_setting
  ssm/client/resume_session
  ssm/client/send_automation_signal
  ssm/client/send_command
  ssm/client/start_access_request
  ssm/client/start_associations_once
  ssm/client/start_automation_execution
  ssm/client/start_change_request_execution
  ssm/client/start_execution_preview
  ssm/client/start_session
  ssm/client/stop_automation_execution
  ssm/client/terminate_session
  ssm/client/unlabel_parameter_version
  ssm/client/update_association
  ssm/client/update_association_status
  ssm/client/update_document
  ssm/client/update_document_default_version
  ssm/client/update_document_metadata
  ssm/client/update_maintenance_window
  ssm/client/update_maintenance_window_target
  ssm/client/update_maintenance_window_task
  ssm/client/update_managed_instance_role
  ssm/client/update_ops_item
  ssm/client/update_ops_metadata
  ssm/client/update_patch_baseline
  ssm/client/update_resource_data_sync
  ssm/client/update_service_setting


==========
Paginators
==========


Paginators are available on a client instance via the ``get_paginator`` method. For more detailed instructions and examples on the usage of paginators, see the paginators `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/paginators.html>`_.

The available paginators are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  ssm/paginator/DescribeActivations
  ssm/paginator/DescribeAssociationExecutionTargets
  ssm/paginator/DescribeAssociationExecutions
  ssm/paginator/DescribeAutomationExecutions
  ssm/paginator/DescribeAutomationStepExecutions
  ssm/paginator/DescribeAvailablePatches
  ssm/paginator/DescribeEffectiveInstanceAssociations
  ssm/paginator/DescribeEffectivePatchesForPatchBaseline
  ssm/paginator/DescribeInstanceAssociationsStatus
  ssm/paginator/DescribeInstanceInformation
  ssm/paginator/DescribeInstancePatchStates
  ssm/paginator/DescribeInstancePatchStatesForPatchGroup
  ssm/paginator/DescribeInstancePatches
  ssm/paginator/DescribeInstanceProperties
  ssm/paginator/DescribeInventoryDeletions
  ssm/paginator/DescribeMaintenanceWindowExecutionTaskInvocations
  ssm/paginator/DescribeMaintenanceWindowExecutionTasks
  ssm/paginator/DescribeMaintenanceWindowExecutions
  ssm/paginator/DescribeMaintenanceWindowSchedule
  ssm/paginator/DescribeMaintenanceWindowTargets
  ssm/paginator/DescribeMaintenanceWindowTasks
  ssm/paginator/DescribeMaintenanceWindows
  ssm/paginator/DescribeMaintenanceWindowsForTarget
  ssm/paginator/DescribeOpsItems
  ssm/paginator/DescribeParameters
  ssm/paginator/DescribePatchBaselines
  ssm/paginator/DescribePatchGroups
  ssm/paginator/DescribePatchProperties
  ssm/paginator/DescribeSessions
  ssm/paginator/GetInventory
  ssm/paginator/GetInventorySchema
  ssm/paginator/GetOpsSummary
  ssm/paginator/GetParameterHistory
  ssm/paginator/GetParametersByPath
  ssm/paginator/GetResourcePolicies
  ssm/paginator/ListAssociationVersions
  ssm/paginator/ListAssociations
  ssm/paginator/ListCommandInvocations
  ssm/paginator/ListCommands
  ssm/paginator/ListComplianceItems
  ssm/paginator/ListComplianceSummaries
  ssm/paginator/ListDocumentVersions
  ssm/paginator/ListDocuments
  ssm/paginator/ListNodes
  ssm/paginator/ListNodesSummary
  ssm/paginator/ListOpsItemEvents
  ssm/paginator/ListOpsItemRelatedItems
  ssm/paginator/ListOpsMetadata
  ssm/paginator/ListResourceComplianceSummaries
  ssm/paginator/ListResourceDataSync


=======
Waiters
=======


Waiters are available on a client instance via the ``get_waiter`` method. For more detailed instructions and examples on the usage or waiters, see the waiters `user guide <https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#waiters>`_.

The available waiters are:

.. toctree::
  :maxdepth: 1
  :titlesonly:

  ssm/waiter/CommandExecuted
