SSM¶
Client¶
- 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. To get started, see Setting up Amazon Web Services Systems Manager.
Related resources
For information about each of the tools that comprise Systems Manager, see Using Systems Manager tools 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 .
For information about AppConfig, a tool in Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
For information about Incident Manager, a tool in Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .
client = session.create_client('ssm')
These are the available methods:
- add_tags_to_resource
- associate_ops_item_related_item
- can_paginate
- cancel_command
- cancel_maintenance_window_execution
- close
- create_activation
- create_association
- create_association_batch
- create_document
- create_maintenance_window
- create_ops_item
- create_ops_metadata
- create_patch_baseline
- create_resource_data_sync
- delete_activation
- delete_association
- delete_document
- delete_inventory
- delete_maintenance_window
- delete_ops_item
- delete_ops_metadata
- delete_parameter
- delete_parameters
- delete_patch_baseline
- delete_resource_data_sync
- delete_resource_policy
- deregister_managed_instance
- deregister_patch_baseline_for_patch_group
- deregister_target_from_maintenance_window
- deregister_task_from_maintenance_window
- describe_activations
- describe_association
- describe_association_execution_targets
- describe_association_executions
- describe_automation_executions
- describe_automation_step_executions
- describe_available_patches
- describe_document
- describe_document_permission
- describe_effective_instance_associations
- describe_effective_patches_for_patch_baseline
- describe_instance_associations_status
- describe_instance_information
- describe_instance_patch_states
- describe_instance_patch_states_for_patch_group
- describe_instance_patches
- describe_instance_properties
- describe_inventory_deletions
- describe_maintenance_window_execution_task_invocations
- describe_maintenance_window_execution_tasks
- describe_maintenance_window_executions
- describe_maintenance_window_schedule
- describe_maintenance_window_targets
- describe_maintenance_window_tasks
- describe_maintenance_windows
- describe_maintenance_windows_for_target
- describe_ops_items
- describe_parameters
- describe_patch_baselines
- describe_patch_group_state
- describe_patch_groups
- describe_patch_properties
- describe_sessions
- disassociate_ops_item_related_item
- get_access_token
- get_automation_execution
- get_calendar_state
- get_command_invocation
- get_connection_status
- get_default_patch_baseline
- get_deployable_patch_snapshot_for_instance
- get_document
- get_execution_preview
- get_inventory
- get_inventory_schema
- get_maintenance_window
- get_maintenance_window_execution
- get_maintenance_window_execution_task
- get_maintenance_window_execution_task_invocation
- get_maintenance_window_task
- get_ops_item
- get_ops_metadata
- get_ops_summary
- get_paginator
- get_parameter
- get_parameter_history
- get_parameters
- get_parameters_by_path
- get_patch_baseline
- get_patch_baseline_for_patch_group
- get_resource_policies
- get_service_setting
- get_waiter
- label_parameter_version
- list_association_versions
- list_associations
- list_command_invocations
- list_commands
- list_compliance_items
- list_compliance_summaries
- list_document_metadata_history
- list_document_versions
- list_documents
- list_inventory_entries
- list_nodes
- list_nodes_summary
- list_ops_item_events
- list_ops_item_related_items
- list_ops_metadata
- list_resource_compliance_summaries
- list_resource_data_sync
- list_tags_for_resource
- modify_document_permission
- put_compliance_items
- put_inventory
- put_parameter
- put_resource_policy
- register_default_patch_baseline
- register_patch_baseline_for_patch_group
- register_target_with_maintenance_window
- register_task_with_maintenance_window
- remove_tags_from_resource
- reset_service_setting
- resume_session
- send_automation_signal
- send_command
- start_access_request
- start_associations_once
- start_automation_execution
- start_change_request_execution
- start_execution_preview
- start_session
- stop_automation_execution
- terminate_session
- unlabel_parameter_version
- update_association
- update_association_status
- update_document
- update_document_default_version
- update_document_metadata
- update_maintenance_window
- update_maintenance_window_target
- update_maintenance_window_task
- update_managed_instance_role
- update_ops_item
- update_ops_metadata
- update_patch_baseline
- update_resource_data_sync
- update_service_setting
Client Exceptions¶
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- AccessDeniedException
- AlreadyExistsException
- AssociatedInstances
- AssociationAlreadyExists
- AssociationDoesNotExist
- AssociationExecutionDoesNotExist
- AssociationLimitExceeded
- AssociationVersionLimitExceeded
- AutomationDefinitionNotApprovedException
- AutomationDefinitionNotFoundException
- AutomationDefinitionVersionNotFoundException
- AutomationExecutionLimitExceededException
- AutomationExecutionNotFoundException
- AutomationStepNotFoundException
- ComplianceTypeCountLimitExceededException
- CustomSchemaCountLimitExceededException
- DocumentAlreadyExists
- DocumentLimitExceeded
- DocumentPermissionLimit
- DocumentVersionLimitExceeded
- DoesNotExistException
- DuplicateDocumentContent
- DuplicateDocumentVersionName
- DuplicateInstanceId
- FeatureNotAvailableException
- HierarchyLevelLimitExceededException
- HierarchyTypeMismatchException
- IdempotentParameterMismatch
- IncompatiblePolicyException
- InternalServerError
- InvalidActivation
- InvalidActivationId
- InvalidAggregatorException
- InvalidAllowedPatternException
- InvalidAssociation
- InvalidAssociationVersion
- InvalidAutomationExecutionParametersException
- InvalidAutomationSignalException
- InvalidAutomationStatusUpdateException
- InvalidCommandId
- InvalidDeleteInventoryParametersException
- InvalidDeletionIdException
- InvalidDocument
- InvalidDocumentContent
- InvalidDocumentOperation
- InvalidDocumentSchemaVersion
- InvalidDocumentType
- InvalidDocumentVersion
- InvalidFilter
- InvalidFilterKey
- InvalidFilterOption
- InvalidFilterValue
- InvalidInstanceId
- InvalidInstanceInformationFilterValue
- InvalidInstancePropertyFilterValue
- InvalidInventoryGroupException
- InvalidInventoryItemContextException
- InvalidInventoryRequestException
- InvalidItemContentException
- InvalidKeyId
- InvalidNextToken
- InvalidNotificationConfig
- InvalidOptionException
- InvalidOutputFolder
- InvalidOutputLocation
- InvalidParameters
- InvalidPermissionType
- InvalidPluginName
- InvalidPolicyAttributeException
- InvalidPolicyTypeException
- InvalidResourceId
- InvalidResourceType
- InvalidResultAttributeException
- InvalidRole
- InvalidSchedule
- InvalidTag
- InvalidTarget
- InvalidTargetMaps
- InvalidTypeNameException
- InvalidUpdate
- InvocationDoesNotExist
- ItemContentMismatchException
- ItemSizeLimitExceededException
- MalformedResourcePolicyDocumentException
- MaxDocumentSizeExceeded
- OpsItemAccessDeniedException
- OpsItemAlreadyExistsException
- OpsItemConflictException
- OpsItemInvalidParameterException
- OpsItemLimitExceededException
- OpsItemNotFoundException
- OpsItemRelatedItemAlreadyExistsException
- OpsItemRelatedItemAssociationNotFoundException
- OpsMetadataAlreadyExistsException
- OpsMetadataInvalidArgumentException
- OpsMetadataKeyLimitExceededException
- OpsMetadataLimitExceededException
- OpsMetadataNotFoundException
- OpsMetadataTooManyUpdatesException
- ParameterAlreadyExists
- ParameterLimitExceeded
- ParameterMaxVersionLimitExceeded
- ParameterNotFound
- ParameterPatternMismatchException
- ParameterVersionLabelLimitExceeded
- ParameterVersionNotFound
- PoliciesLimitExceededException
- ResourceDataSyncAlreadyExistsException
- ResourceDataSyncConflictException
- ResourceDataSyncCountExceededException
- ResourceDataSyncInvalidConfigurationException
- ResourceDataSyncNotFoundException
- ResourceInUseException
- ResourceLimitExceededException
- ResourceNotFoundException
- ResourcePolicyConflictException
- ResourcePolicyInvalidParameterException
- ResourcePolicyLimitExceededException
- ResourcePolicyNotFoundException
- ServiceQuotaExceededException
- ServiceSettingNotFound
- StatusUnchanged
- SubTypeCountLimitExceededException
- TargetInUseException
- TargetNotConnected
- ThrottlingException
- TooManyTagsError
- TooManyUpdates
- TotalSizeLimitExceededException
- UnsupportedCalendarException
- UnsupportedFeatureRequiredException
- UnsupportedInventoryItemContextException
- UnsupportedInventorySchemaVersionException
- UnsupportedOperatingSystem
- UnsupportedOperationException
- UnsupportedParameterType
- UnsupportedPlatformType
- ValidationException
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.
The available paginators are:
- DescribeActivations
- DescribeAssociationExecutionTargets
- DescribeAssociationExecutions
- DescribeAutomationExecutions
- DescribeAutomationStepExecutions
- DescribeAvailablePatches
- DescribeEffectiveInstanceAssociations
- DescribeEffectivePatchesForPatchBaseline
- DescribeInstanceAssociationsStatus
- DescribeInstanceInformation
- DescribeInstancePatchStates
- DescribeInstancePatchStatesForPatchGroup
- DescribeInstancePatches
- DescribeInstanceProperties
- DescribeInventoryDeletions
- DescribeMaintenanceWindowExecutionTaskInvocations
- DescribeMaintenanceWindowExecutionTasks
- DescribeMaintenanceWindowExecutions
- DescribeMaintenanceWindowSchedule
- DescribeMaintenanceWindowTargets
- DescribeMaintenanceWindowTasks
- DescribeMaintenanceWindows
- DescribeMaintenanceWindowsForTarget
- DescribeOpsItems
- DescribeParameters
- DescribePatchBaselines
- DescribePatchGroups
- DescribePatchProperties
- DescribeSessions
- GetInventory
- GetInventorySchema
- GetOpsSummary
- GetParameterHistory
- GetParametersByPath
- GetResourcePolicies
- ListAssociationVersions
- ListAssociations
- ListCommandInvocations
- ListCommands
- ListComplianceItems
- ListComplianceSummaries
- ListDocumentVersions
- ListDocuments
- ListNodes
- ListNodesSummary
- ListOpsItemEvents
- ListOpsItemRelatedItems
- ListOpsMetadata
- ListResourceComplianceSummaries
- 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.
The available waiters are: