SSMClient
Auto-generated documentation for SSM type annotations stubs module mypy-boto3-ssm.
SSMClient
Type annotations and code completion for boto3.client("ssm")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_ssm.client import SSMClient
def get_ssm_client() -> SSMClient:
return Session().client("ssm")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("ssm").exceptions
structure.
client = boto3.client("ssm")
try:
do_something(client)
except (
client.AlreadyExistsException,
client.AssociatedInstances,
client.AssociationAlreadyExists,
client.AssociationDoesNotExist,
client.AssociationExecutionDoesNotExist,
client.AssociationLimitExceeded,
client.AssociationVersionLimitExceeded,
client.AutomationDefinitionNotApprovedException,
client.AutomationDefinitionNotFoundException,
client.AutomationDefinitionVersionNotFoundException,
client.AutomationExecutionLimitExceededException,
client.AutomationExecutionNotFoundException,
client.AutomationStepNotFoundException,
client.ClientError,
client.ComplianceTypeCountLimitExceededException,
client.CustomSchemaCountLimitExceededException,
client.DocumentAlreadyExists,
client.DocumentLimitExceeded,
client.DocumentPermissionLimit,
client.DocumentVersionLimitExceeded,
client.DoesNotExistException,
client.DuplicateDocumentContent,
client.DuplicateDocumentVersionName,
client.DuplicateInstanceId,
client.FeatureNotAvailableException,
client.HierarchyLevelLimitExceededException,
client.HierarchyTypeMismatchException,
client.IdempotentParameterMismatch,
client.IncompatiblePolicyException,
client.InternalServerError,
client.InvalidActivation,
client.InvalidActivationId,
client.InvalidAggregatorException,
client.InvalidAllowedPatternException,
client.InvalidAssociation,
client.InvalidAssociationVersion,
client.InvalidAutomationExecutionParametersException,
client.InvalidAutomationSignalException,
client.InvalidAutomationStatusUpdateException,
client.InvalidCommandId,
client.InvalidDeleteInventoryParametersException,
client.InvalidDeletionIdException,
client.InvalidDocument,
client.InvalidDocumentContent,
client.InvalidDocumentOperation,
client.InvalidDocumentSchemaVersion,
client.InvalidDocumentType,
client.InvalidDocumentVersion,
client.InvalidFilter,
client.InvalidFilterKey,
client.InvalidFilterOption,
client.InvalidFilterValue,
client.InvalidInstanceId,
client.InvalidInstanceInformationFilterValue,
client.InvalidInventoryGroupException,
client.InvalidInventoryItemContextException,
client.InvalidInventoryRequestException,
client.InvalidItemContentException,
client.InvalidKeyId,
client.InvalidNextToken,
client.InvalidNotificationConfig,
client.InvalidOptionException,
client.InvalidOutputFolder,
client.InvalidOutputLocation,
client.InvalidParameters,
client.InvalidPermissionType,
client.InvalidPluginName,
client.InvalidPolicyAttributeException,
client.InvalidPolicyTypeException,
client.InvalidResourceId,
client.InvalidResourceType,
client.InvalidResultAttributeException,
client.InvalidRole,
client.InvalidSchedule,
client.InvalidTag,
client.InvalidTarget,
client.InvalidTargetMaps,
client.InvalidTypeNameException,
client.InvalidUpdate,
client.InvocationDoesNotExist,
client.ItemContentMismatchException,
client.ItemSizeLimitExceededException,
client.MaxDocumentSizeExceeded,
client.OpsItemAccessDeniedException,
client.OpsItemAlreadyExistsException,
client.OpsItemInvalidParameterException,
client.OpsItemLimitExceededException,
client.OpsItemNotFoundException,
client.OpsItemRelatedItemAlreadyExistsException,
client.OpsItemRelatedItemAssociationNotFoundException,
client.OpsMetadataAlreadyExistsException,
client.OpsMetadataInvalidArgumentException,
client.OpsMetadataKeyLimitExceededException,
client.OpsMetadataLimitExceededException,
client.OpsMetadataNotFoundException,
client.OpsMetadataTooManyUpdatesException,
client.ParameterAlreadyExists,
client.ParameterLimitExceeded,
client.ParameterMaxVersionLimitExceeded,
client.ParameterNotFound,
client.ParameterPatternMismatchException,
client.ParameterVersionLabelLimitExceeded,
client.ParameterVersionNotFound,
client.PoliciesLimitExceededException,
client.ResourceDataSyncAlreadyExistsException,
client.ResourceDataSyncConflictException,
client.ResourceDataSyncCountExceededException,
client.ResourceDataSyncInvalidConfigurationException,
client.ResourceDataSyncNotFoundException,
client.ResourceInUseException,
client.ResourceLimitExceededException,
client.ResourcePolicyConflictException,
client.ResourcePolicyInvalidParameterException,
client.ResourcePolicyLimitExceededException,
client.ServiceSettingNotFound,
client.StatusUnchanged,
client.SubTypeCountLimitExceededException,
client.TargetInUseException,
client.TargetNotConnected,
client.TooManyTagsError,
client.TooManyUpdates,
client.TotalSizeLimitExceededException,
client.UnsupportedCalendarException,
client.UnsupportedFeatureRequiredException,
client.UnsupportedInventoryItemContextException,
client.UnsupportedInventorySchemaVersionException,
client.UnsupportedOperatingSystem,
client.UnsupportedParameterType,
client.UnsupportedPlatformType,
) as e:
print(e)
from mypy_boto3_ssm.client import Exceptions
def handle_error(exc: Exceptions.AlreadyExistsException) -> None:
...
Methods
add_tags_to_resource
Adds or overwrites one or more tags for the specified resource.
Type annotations and code completion for boto3.client("ssm").add_tags_to_resource
method.
boto3 documentation
def add_tags_to_resource(
self,
*,
ResourceType: ResourceTypeForTaggingType, # (1)
ResourceId: str,
Tags: Sequence[TagTypeDef], # (2)
) -> Dict[str, Any]:
...
- See ResourceTypeForTaggingType
- See TagTypeDef
kwargs: AddTagsToResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
"ResourceId": ...,
"Tags": ...,
}
parent.add_tags_to_resource(**kwargs)
associate_ops_item_related_item
Associates a related item to a Systems Manager OpsCenter OpsItem.
Type annotations and code completion for boto3.client("ssm").associate_ops_item_related_item
method.
boto3 documentation
def associate_ops_item_related_item(
self,
*,
OpsItemId: str,
AssociationType: str,
ResourceType: str,
ResourceUri: str,
) -> AssociateOpsItemRelatedItemResponseTypeDef: # (1)
...
kwargs: AssociateOpsItemRelatedItemRequestRequestTypeDef = { # (1)
"OpsItemId": ...,
"AssociationType": ...,
"ResourceType": ...,
"ResourceUri": ...,
}
parent.associate_ops_item_related_item(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("ssm").can_paginate
method.
boto3 documentation
cancel_command
Attempts to cancel the command specified by the Command ID.
Type annotations and code completion for boto3.client("ssm").cancel_command
method.
boto3 documentation
def cancel_command(
self,
*,
CommandId: str,
InstanceIds: Sequence[str] = ...,
) -> Dict[str, Any]:
...
kwargs: CancelCommandRequestRequestTypeDef = { # (1)
"CommandId": ...,
}
parent.cancel_command(**kwargs)
cancel_maintenance_window_execution
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running.
Type annotations and code completion for boto3.client("ssm").cancel_maintenance_window_execution
method.
boto3 documentation
def cancel_maintenance_window_execution(
self,
*,
WindowExecutionId: str,
) -> CancelMaintenanceWindowExecutionResultTypeDef: # (1)
...
kwargs: CancelMaintenanceWindowExecutionRequestRequestTypeDef = { # (1)
"WindowExecutionId": ...,
}
parent.cancel_maintenance_window_execution(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("ssm").close
method.
boto3 documentation
create_activation
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.
Type annotations and code completion for boto3.client("ssm").create_activation
method.
boto3 documentation
def create_activation(
self,
*,
IamRole: str,
Description: str = ...,
DefaultInstanceName: str = ...,
RegistrationLimit: int = ...,
ExpirationDate: Union[datetime, str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
RegistrationMetadata: Sequence[RegistrationMetadataItemTypeDef] = ..., # (2)
) -> CreateActivationResultTypeDef: # (3)
...
kwargs: CreateActivationRequestRequestTypeDef = { # (1)
"IamRole": ...,
}
parent.create_activation(**kwargs)
create_association
A State Manager association defines the state that you want to maintain on your managed nodes.
Type annotations and code completion for boto3.client("ssm").create_association
method.
boto3 documentation
def create_association(
self,
*,
Name: str,
DocumentVersion: str = ...,
InstanceId: str = ...,
Parameters: Mapping[str, Sequence[str]] = ...,
Targets: Sequence[TargetTypeDef] = ..., # (1)
ScheduleExpression: str = ...,
OutputLocation: InstanceAssociationOutputLocationTypeDef = ..., # (2)
AssociationName: str = ...,
AutomationTargetParameterName: str = ...,
MaxErrors: str = ...,
MaxConcurrency: str = ...,
ComplianceSeverity: AssociationComplianceSeverityType = ..., # (3)
SyncCompliance: AssociationSyncComplianceType = ..., # (4)
ApplyOnlyAtCronInterval: bool = ...,
CalendarNames: Sequence[str] = ...,
TargetLocations: Sequence[TargetLocationTypeDef] = ..., # (5)
ScheduleOffset: int = ...,
TargetMaps: Sequence[Mapping[str, Sequence[str]]] = ...,
Tags: Sequence[TagTypeDef] = ..., # (6)
AlarmConfiguration: AlarmConfigurationTypeDef = ..., # (7)
) -> CreateAssociationResultTypeDef: # (8)
...
- See TargetTypeDef
- See InstanceAssociationOutputLocationTypeDef
- See AssociationComplianceSeverityType
- See AssociationSyncComplianceType
- See TargetLocationTypeDef
- See TagTypeDef
- See AlarmConfigurationTypeDef
- See CreateAssociationResultTypeDef
kwargs: CreateAssociationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_association(**kwargs)
create_association_batch
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
Type annotations and code completion for boto3.client("ssm").create_association_batch
method.
boto3 documentation
def create_association_batch(
self,
*,
Entries: Sequence[CreateAssociationBatchRequestEntryTypeDef], # (1)
) -> CreateAssociationBatchResultTypeDef: # (2)
...
kwargs: CreateAssociationBatchRequestRequestTypeDef = { # (1)
"Entries": ...,
}
parent.create_association_batch(**kwargs)
create_document
Creates a Amazon Web Services Systems Manager (SSM document).
Type annotations and code completion for boto3.client("ssm").create_document
method.
boto3 documentation
def create_document(
self,
*,
Content: str,
Name: str,
Requires: Sequence[DocumentRequiresTypeDef] = ..., # (1)
Attachments: Sequence[AttachmentsSourceTypeDef] = ..., # (2)
DisplayName: str = ...,
VersionName: str = ...,
DocumentType: DocumentTypeType = ..., # (3)
DocumentFormat: DocumentFormatType = ..., # (4)
TargetType: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (5)
) -> CreateDocumentResultTypeDef: # (6)
...
- See DocumentRequiresTypeDef
- See AttachmentsSourceTypeDef
- See DocumentTypeType
- See DocumentFormatType
- See TagTypeDef
- See CreateDocumentResultTypeDef
kwargs: CreateDocumentRequestRequestTypeDef = { # (1)
"Content": ...,
"Name": ...,
}
parent.create_document(**kwargs)
create_maintenance_window
Creates a new maintenance window.
Type annotations and code completion for boto3.client("ssm").create_maintenance_window
method.
boto3 documentation
def create_maintenance_window(
self,
*,
Name: str,
Schedule: str,
Duration: int,
Cutoff: int,
AllowUnassociatedTargets: bool,
Description: str = ...,
StartDate: str = ...,
EndDate: str = ...,
ScheduleTimezone: str = ...,
ScheduleOffset: int = ...,
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateMaintenanceWindowResultTypeDef: # (2)
...
kwargs: CreateMaintenanceWindowRequestRequestTypeDef = { # (1)
"Name": ...,
"Schedule": ...,
"Duration": ...,
"Cutoff": ...,
"AllowUnassociatedTargets": ...,
}
parent.create_maintenance_window(**kwargs)
create_ops_item
Creates a new OpsItem.
Type annotations and code completion for boto3.client("ssm").create_ops_item
method.
boto3 documentation
def create_ops_item(
self,
*,
Description: str,
Source: str,
Title: str,
OpsItemType: str = ...,
OperationalData: Mapping[str, OpsItemDataValueTypeDef] = ..., # (1)
Notifications: Sequence[OpsItemNotificationTypeDef] = ..., # (2)
Priority: int = ...,
RelatedOpsItems: Sequence[RelatedOpsItemTypeDef] = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
Category: str = ...,
Severity: str = ...,
ActualStartTime: Union[datetime, str] = ...,
ActualEndTime: Union[datetime, str] = ...,
PlannedStartTime: Union[datetime, str] = ...,
PlannedEndTime: Union[datetime, str] = ...,
AccountId: str = ...,
) -> CreateOpsItemResponseTypeDef: # (5)
...
- See OpsItemDataValueTypeDef
- See OpsItemNotificationTypeDef
- See RelatedOpsItemTypeDef
- See TagTypeDef
- See CreateOpsItemResponseTypeDef
kwargs: CreateOpsItemRequestRequestTypeDef = { # (1)
"Description": ...,
"Source": ...,
"Title": ...,
}
parent.create_ops_item(**kwargs)
create_ops_metadata
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.
Type annotations and code completion for boto3.client("ssm").create_ops_metadata
method.
boto3 documentation
def create_ops_metadata(
self,
*,
ResourceId: str,
Metadata: Mapping[str, MetadataValueTypeDef] = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateOpsMetadataResultTypeDef: # (3)
...
kwargs: CreateOpsMetadataRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.create_ops_metadata(**kwargs)
create_patch_baseline
Creates a patch baseline.
Type annotations and code completion for boto3.client("ssm").create_patch_baseline
method.
boto3 documentation
def create_patch_baseline(
self,
*,
Name: str,
OperatingSystem: OperatingSystemType = ..., # (1)
GlobalFilters: PatchFilterGroupTypeDef = ..., # (2)
ApprovalRules: PatchRuleGroupTypeDef = ..., # (3)
ApprovedPatches: Sequence[str] = ...,
ApprovedPatchesComplianceLevel: PatchComplianceLevelType = ..., # (4)
ApprovedPatchesEnableNonSecurity: bool = ...,
RejectedPatches: Sequence[str] = ...,
RejectedPatchesAction: PatchActionType = ..., # (5)
Description: str = ...,
Sources: Sequence[PatchSourceTypeDef] = ..., # (6)
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (7)
) -> CreatePatchBaselineResultTypeDef: # (8)
...
- See OperatingSystemType
- See PatchFilterGroupTypeDef
- See PatchRuleGroupTypeDef
- See PatchComplianceLevelType
- See PatchActionType
- See PatchSourceTypeDef
- See TagTypeDef
- See CreatePatchBaselineResultTypeDef
kwargs: CreatePatchBaselineRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_patch_baseline(**kwargs)
create_resource_data_sync
A resource data sync helps you view data from multiple sources in a single location.
Type annotations and code completion for boto3.client("ssm").create_resource_data_sync
method.
boto3 documentation
def create_resource_data_sync(
self,
*,
SyncName: str,
S3Destination: ResourceDataSyncS3DestinationTypeDef = ..., # (1)
SyncType: str = ...,
SyncSource: ResourceDataSyncSourceTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
kwargs: CreateResourceDataSyncRequestRequestTypeDef = { # (1)
"SyncName": ...,
}
parent.create_resource_data_sync(**kwargs)
delete_activation
Deletes an activation.
Type annotations and code completion for boto3.client("ssm").delete_activation
method.
boto3 documentation
kwargs: DeleteActivationRequestRequestTypeDef = { # (1)
"ActivationId": ...,
}
parent.delete_activation(**kwargs)
delete_association
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
Type annotations and code completion for boto3.client("ssm").delete_association
method.
boto3 documentation
def delete_association(
self,
*,
Name: str = ...,
InstanceId: str = ...,
AssociationId: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteAssociationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_association(**kwargs)
delete_document
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Type annotations and code completion for boto3.client("ssm").delete_document
method.
boto3 documentation
def delete_document(
self,
*,
Name: str,
DocumentVersion: str = ...,
VersionName: str = ...,
Force: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteDocumentRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_document(**kwargs)
delete_inventory
Delete a custom inventory type or the data associated with a custom Inventory type.
Type annotations and code completion for boto3.client("ssm").delete_inventory
method.
boto3 documentation
def delete_inventory(
self,
*,
TypeName: str,
SchemaDeleteOption: InventorySchemaDeleteOptionType = ..., # (1)
DryRun: bool = ...,
ClientToken: str = ...,
) -> DeleteInventoryResultTypeDef: # (2)
...
kwargs: DeleteInventoryRequestRequestTypeDef = { # (1)
"TypeName": ...,
}
parent.delete_inventory(**kwargs)
delete_maintenance_window
Deletes a maintenance window.
Type annotations and code completion for boto3.client("ssm").delete_maintenance_window
method.
boto3 documentation
def delete_maintenance_window(
self,
*,
WindowId: str,
) -> DeleteMaintenanceWindowResultTypeDef: # (1)
...
kwargs: DeleteMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.delete_maintenance_window(**kwargs)
delete_ops_metadata
Delete OpsMetadata related to an application.
Type annotations and code completion for boto3.client("ssm").delete_ops_metadata
method.
boto3 documentation
kwargs: DeleteOpsMetadataRequestRequestTypeDef = { # (1)
"OpsMetadataArn": ...,
}
parent.delete_ops_metadata(**kwargs)
delete_parameter
Delete a parameter from the system.
Type annotations and code completion for boto3.client("ssm").delete_parameter
method.
boto3 documentation
kwargs: DeleteParameterRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_parameter(**kwargs)
delete_parameters
Delete a list of parameters.
Type annotations and code completion for boto3.client("ssm").delete_parameters
method.
boto3 documentation
def delete_parameters(
self,
*,
Names: Sequence[str],
) -> DeleteParametersResultTypeDef: # (1)
...
kwargs: DeleteParametersRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.delete_parameters(**kwargs)
delete_patch_baseline
Deletes a patch baseline.
Type annotations and code completion for boto3.client("ssm").delete_patch_baseline
method.
boto3 documentation
def delete_patch_baseline(
self,
*,
BaselineId: str,
) -> DeletePatchBaselineResultTypeDef: # (1)
...
kwargs: DeletePatchBaselineRequestRequestTypeDef = { # (1)
"BaselineId": ...,
}
parent.delete_patch_baseline(**kwargs)
delete_resource_data_sync
Deletes a resource data sync configuration.
Type annotations and code completion for boto3.client("ssm").delete_resource_data_sync
method.
boto3 documentation
def delete_resource_data_sync(
self,
*,
SyncName: str,
SyncType: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteResourceDataSyncRequestRequestTypeDef = { # (1)
"SyncName": ...,
}
parent.delete_resource_data_sync(**kwargs)
delete_resource_policy
Deletes a Systems Manager resource policy.
Type annotations and code completion for boto3.client("ssm").delete_resource_policy
method.
boto3 documentation
def delete_resource_policy(
self,
*,
ResourceArn: str,
PolicyId: str,
PolicyHash: str,
) -> Dict[str, Any]:
...
kwargs: DeleteResourcePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"PolicyId": ...,
"PolicyHash": ...,
}
parent.delete_resource_policy(**kwargs)
deregister_managed_instance
Removes the server or virtual machine from the list of registered servers.
Type annotations and code completion for boto3.client("ssm").deregister_managed_instance
method.
boto3 documentation
def deregister_managed_instance(
self,
*,
InstanceId: str,
) -> Dict[str, Any]:
...
kwargs: DeregisterManagedInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.deregister_managed_instance(**kwargs)
deregister_patch_baseline_for_patch_group
Removes a patch group from a patch baseline.
Type annotations and code completion for boto3.client("ssm").deregister_patch_baseline_for_patch_group
method.
boto3 documentation
def deregister_patch_baseline_for_patch_group(
self,
*,
BaselineId: str,
PatchGroup: str,
) -> DeregisterPatchBaselineForPatchGroupResultTypeDef: # (1)
...
kwargs: DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef = { # (1)
"BaselineId": ...,
"PatchGroup": ...,
}
parent.deregister_patch_baseline_for_patch_group(**kwargs)
deregister_target_from_maintenance_window
Removes a target from a maintenance window.
Type annotations and code completion for boto3.client("ssm").deregister_target_from_maintenance_window
method.
boto3 documentation
def deregister_target_from_maintenance_window(
self,
*,
WindowId: str,
WindowTargetId: str,
Safe: bool = ...,
) -> DeregisterTargetFromMaintenanceWindowResultTypeDef: # (1)
...
kwargs: DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
"WindowTargetId": ...,
}
parent.deregister_target_from_maintenance_window(**kwargs)
deregister_task_from_maintenance_window
Removes a task from a maintenance window.
Type annotations and code completion for boto3.client("ssm").deregister_task_from_maintenance_window
method.
boto3 documentation
def deregister_task_from_maintenance_window(
self,
*,
WindowId: str,
WindowTaskId: str,
) -> DeregisterTaskFromMaintenanceWindowResultTypeDef: # (1)
...
kwargs: DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
"WindowTaskId": ...,
}
parent.deregister_task_from_maintenance_window(**kwargs)
describe_activations
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.
Type annotations and code completion for boto3.client("ssm").describe_activations
method.
boto3 documentation
def describe_activations(
self,
*,
Filters: Sequence[DescribeActivationsFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeActivationsResultTypeDef: # (2)
...
kwargs: DescribeActivationsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_activations(**kwargs)
describe_association
Describes the association for the specified target or managed node.
Type annotations and code completion for boto3.client("ssm").describe_association
method.
boto3 documentation
def describe_association(
self,
*,
Name: str = ...,
InstanceId: str = ...,
AssociationId: str = ...,
AssociationVersion: str = ...,
) -> DescribeAssociationResultTypeDef: # (1)
...
kwargs: DescribeAssociationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_association(**kwargs)
describe_association_execution_targets
Views information about a specific execution of a specific association.
Type annotations and code completion for boto3.client("ssm").describe_association_execution_targets
method.
boto3 documentation
def describe_association_execution_targets(
self,
*,
AssociationId: str,
ExecutionId: str,
Filters: Sequence[AssociationExecutionTargetsFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAssociationExecutionTargetsResultTypeDef: # (2)
...
kwargs: DescribeAssociationExecutionTargetsRequestRequestTypeDef = { # (1)
"AssociationId": ...,
"ExecutionId": ...,
}
parent.describe_association_execution_targets(**kwargs)
describe_association_executions
Views all executions for a specific association ID.
Type annotations and code completion for boto3.client("ssm").describe_association_executions
method.
boto3 documentation
def describe_association_executions(
self,
*,
AssociationId: str,
Filters: Sequence[AssociationExecutionFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAssociationExecutionsResultTypeDef: # (2)
...
kwargs: DescribeAssociationExecutionsRequestRequestTypeDef = { # (1)
"AssociationId": ...,
}
parent.describe_association_executions(**kwargs)
describe_automation_executions
Provides details about all active and terminated Automation executions.
Type annotations and code completion for boto3.client("ssm").describe_automation_executions
method.
boto3 documentation
def describe_automation_executions(
self,
*,
Filters: Sequence[AutomationExecutionFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAutomationExecutionsResultTypeDef: # (2)
...
kwargs: DescribeAutomationExecutionsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_automation_executions(**kwargs)
describe_automation_step_executions
Information about all active and terminated step executions in an Automation workflow.
Type annotations and code completion for boto3.client("ssm").describe_automation_step_executions
method.
boto3 documentation
def describe_automation_step_executions(
self,
*,
AutomationExecutionId: str,
Filters: Sequence[StepExecutionFilterTypeDef] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
ReverseOrder: bool = ...,
) -> DescribeAutomationStepExecutionsResultTypeDef: # (2)
...
kwargs: DescribeAutomationStepExecutionsRequestRequestTypeDef = { # (1)
"AutomationExecutionId": ...,
}
parent.describe_automation_step_executions(**kwargs)
describe_available_patches
Lists all patches eligible to be included in a patch baseline.
Type annotations and code completion for boto3.client("ssm").describe_available_patches
method.
boto3 documentation
def describe_available_patches(
self,
*,
Filters: Sequence[PatchOrchestratorFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAvailablePatchesResultTypeDef: # (2)
...
kwargs: DescribeAvailablePatchesRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_available_patches(**kwargs)
describe_document
Describes the specified Amazon Web Services Systems Manager document (SSM document).
Type annotations and code completion for boto3.client("ssm").describe_document
method.
boto3 documentation
def describe_document(
self,
*,
Name: str,
DocumentVersion: str = ...,
VersionName: str = ...,
) -> DescribeDocumentResultTypeDef: # (1)
...
kwargs: DescribeDocumentRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_document(**kwargs)
describe_document_permission
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).
Type annotations and code completion for boto3.client("ssm").describe_document_permission
method.
boto3 documentation
def describe_document_permission(
self,
*,
Name: str,
PermissionType: DocumentPermissionTypeType, # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeDocumentPermissionResponseTypeDef: # (2)
...
kwargs: DescribeDocumentPermissionRequestRequestTypeDef = { # (1)
"Name": ...,
"PermissionType": ...,
}
parent.describe_document_permission(**kwargs)
describe_effective_instance_associations
All associations for the managed node(s).
Type annotations and code completion for boto3.client("ssm").describe_effective_instance_associations
method.
boto3 documentation
def describe_effective_instance_associations(
self,
*,
InstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeEffectiveInstanceAssociationsResultTypeDef: # (1)
...
kwargs: DescribeEffectiveInstanceAssociationsRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_effective_instance_associations(**kwargs)
describe_effective_patches_for_patch_baseline
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
Type annotations and code completion for boto3.client("ssm").describe_effective_patches_for_patch_baseline
method.
boto3 documentation
def describe_effective_patches_for_patch_baseline(
self,
*,
BaselineId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeEffectivePatchesForPatchBaselineResultTypeDef: # (1)
...
kwargs: DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef = { # (1)
"BaselineId": ...,
}
parent.describe_effective_patches_for_patch_baseline(**kwargs)
describe_instance_associations_status
The status of the associations for the managed node(s).
Type annotations and code completion for boto3.client("ssm").describe_instance_associations_status
method.
boto3 documentation
def describe_instance_associations_status(
self,
*,
InstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeInstanceAssociationsStatusResultTypeDef: # (1)
...
kwargs: DescribeInstanceAssociationsStatusRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_instance_associations_status(**kwargs)
describe_instance_information
Describes one or more of your managed nodes, including information about the operating system platform, the version of SSM Agent installed on the managed node, node status, and so on.
Type annotations and code completion for boto3.client("ssm").describe_instance_information
method.
boto3 documentation
def describe_instance_information(
self,
*,
InstanceInformationFilterList: Sequence[InstanceInformationFilterTypeDef] = ..., # (1)
Filters: Sequence[InstanceInformationStringFilterTypeDef] = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeInstanceInformationResultTypeDef: # (3)
...
- See InstanceInformationFilterTypeDef
- See InstanceInformationStringFilterTypeDef
- See DescribeInstanceInformationResultTypeDef
kwargs: DescribeInstanceInformationRequestRequestTypeDef = { # (1)
"InstanceInformationFilterList": ...,
}
parent.describe_instance_information(**kwargs)
describe_instance_patch_states
Retrieves the high-level patch state of one or more managed nodes.
Type annotations and code completion for boto3.client("ssm").describe_instance_patch_states
method.
boto3 documentation
def describe_instance_patch_states(
self,
*,
InstanceIds: Sequence[str],
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeInstancePatchStatesResultTypeDef: # (1)
...
kwargs: DescribeInstancePatchStatesRequestRequestTypeDef = { # (1)
"InstanceIds": ...,
}
parent.describe_instance_patch_states(**kwargs)
describe_instance_patch_states_for_patch_group
Retrieves the high-level patch state for the managed nodes in the specified patch group.
Type annotations and code completion for boto3.client("ssm").describe_instance_patch_states_for_patch_group
method.
boto3 documentation
def describe_instance_patch_states_for_patch_group(
self,
*,
PatchGroup: str,
Filters: Sequence[InstancePatchStateFilterTypeDef] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeInstancePatchStatesForPatchGroupResultTypeDef: # (2)
...
kwargs: DescribeInstancePatchStatesForPatchGroupRequestRequestTypeDef = { # (1)
"PatchGroup": ...,
}
parent.describe_instance_patch_states_for_patch_group(**kwargs)
describe_instance_patches
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
Type annotations and code completion for boto3.client("ssm").describe_instance_patches
method.
boto3 documentation
def describe_instance_patches(
self,
*,
InstanceId: str,
Filters: Sequence[PatchOrchestratorFilterTypeDef] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeInstancePatchesResultTypeDef: # (2)
...
kwargs: DescribeInstancePatchesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.describe_instance_patches(**kwargs)
describe_inventory_deletions
Describes a specific delete inventory operation.
Type annotations and code completion for boto3.client("ssm").describe_inventory_deletions
method.
boto3 documentation
def describe_inventory_deletions(
self,
*,
DeletionId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> DescribeInventoryDeletionsResultTypeDef: # (1)
...
kwargs: DescribeInventoryDeletionsRequestRequestTypeDef = { # (1)
"DeletionId": ...,
}
parent.describe_inventory_deletions(**kwargs)
describe_maintenance_window_execution_task_invocations
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_window_execution_task_invocations
method.
boto3 documentation
def describe_maintenance_window_execution_task_invocations(
self,
*,
WindowExecutionId: str,
TaskId: str,
Filters: Sequence[MaintenanceWindowFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowExecutionTaskInvocationsResultTypeDef: # (2)
...
- See MaintenanceWindowFilterTypeDef
- See DescribeMaintenanceWindowExecutionTaskInvocationsResultTypeDef
kwargs: DescribeMaintenanceWindowExecutionTaskInvocationsRequestRequestTypeDef = { # (1)
"WindowExecutionId": ...,
"TaskId": ...,
}
parent.describe_maintenance_window_execution_task_invocations(**kwargs)
describe_maintenance_window_execution_tasks
For a given maintenance window execution, lists the tasks that were run.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_window_execution_tasks
method.
boto3 documentation
def describe_maintenance_window_execution_tasks(
self,
*,
WindowExecutionId: str,
Filters: Sequence[MaintenanceWindowFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowExecutionTasksResultTypeDef: # (2)
...
kwargs: DescribeMaintenanceWindowExecutionTasksRequestRequestTypeDef = { # (1)
"WindowExecutionId": ...,
}
parent.describe_maintenance_window_execution_tasks(**kwargs)
describe_maintenance_window_executions
Lists the executions of a maintenance window.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_window_executions
method.
boto3 documentation
def describe_maintenance_window_executions(
self,
*,
WindowId: str,
Filters: Sequence[MaintenanceWindowFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowExecutionsResultTypeDef: # (2)
...
kwargs: DescribeMaintenanceWindowExecutionsRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.describe_maintenance_window_executions(**kwargs)
describe_maintenance_window_schedule
Retrieves information about upcoming executions of a maintenance window.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_window_schedule
method.
boto3 documentation
def describe_maintenance_window_schedule(
self,
*,
WindowId: str = ...,
Targets: Sequence[TargetTypeDef] = ..., # (1)
ResourceType: MaintenanceWindowResourceTypeType = ..., # (2)
Filters: Sequence[PatchOrchestratorFilterTypeDef] = ..., # (3)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowScheduleResultTypeDef: # (4)
...
- See TargetTypeDef
- See MaintenanceWindowResourceTypeType
- See PatchOrchestratorFilterTypeDef
- See DescribeMaintenanceWindowScheduleResultTypeDef
kwargs: DescribeMaintenanceWindowScheduleRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.describe_maintenance_window_schedule(**kwargs)
describe_maintenance_window_targets
Lists the targets registered with the maintenance window.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_window_targets
method.
boto3 documentation
def describe_maintenance_window_targets(
self,
*,
WindowId: str,
Filters: Sequence[MaintenanceWindowFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowTargetsResultTypeDef: # (2)
...
kwargs: DescribeMaintenanceWindowTargetsRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.describe_maintenance_window_targets(**kwargs)
describe_maintenance_window_tasks
Lists the tasks in a maintenance window.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_window_tasks
method.
boto3 documentation
def describe_maintenance_window_tasks(
self,
*,
WindowId: str,
Filters: Sequence[MaintenanceWindowFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowTasksResultTypeDef: # (2)
...
kwargs: DescribeMaintenanceWindowTasksRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.describe_maintenance_window_tasks(**kwargs)
describe_maintenance_windows
Retrieves the maintenance windows in an Amazon Web Services account.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_windows
method.
boto3 documentation
def describe_maintenance_windows(
self,
*,
Filters: Sequence[MaintenanceWindowFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowsResultTypeDef: # (2)
...
kwargs: DescribeMaintenanceWindowsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_maintenance_windows(**kwargs)
describe_maintenance_windows_for_target
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
Type annotations and code completion for boto3.client("ssm").describe_maintenance_windows_for_target
method.
boto3 documentation
def describe_maintenance_windows_for_target(
self,
*,
Targets: Sequence[TargetTypeDef], # (1)
ResourceType: MaintenanceWindowResourceTypeType, # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeMaintenanceWindowsForTargetResultTypeDef: # (3)
...
- See TargetTypeDef
- See MaintenanceWindowResourceTypeType
- See DescribeMaintenanceWindowsForTargetResultTypeDef
kwargs: DescribeMaintenanceWindowsForTargetRequestRequestTypeDef = { # (1)
"Targets": ...,
"ResourceType": ...,
}
parent.describe_maintenance_windows_for_target(**kwargs)
describe_ops_items
Query a set of OpsItems.
Type annotations and code completion for boto3.client("ssm").describe_ops_items
method.
boto3 documentation
def describe_ops_items(
self,
*,
OpsItemFilters: Sequence[OpsItemFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeOpsItemsResponseTypeDef: # (2)
...
kwargs: DescribeOpsItemsRequestRequestTypeDef = { # (1)
"OpsItemFilters": ...,
}
parent.describe_ops_items(**kwargs)
describe_parameters
Get information about a parameter.
Type annotations and code completion for boto3.client("ssm").describe_parameters
method.
boto3 documentation
def describe_parameters(
self,
*,
Filters: Sequence[ParametersFilterTypeDef] = ..., # (1)
ParameterFilters: Sequence[ParameterStringFilterTypeDef] = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeParametersResultTypeDef: # (3)
...
kwargs: DescribeParametersRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_parameters(**kwargs)
describe_patch_baselines
Lists the patch baselines in your Amazon Web Services account.
Type annotations and code completion for boto3.client("ssm").describe_patch_baselines
method.
boto3 documentation
def describe_patch_baselines(
self,
*,
Filters: Sequence[PatchOrchestratorFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribePatchBaselinesResultTypeDef: # (2)
...
kwargs: DescribePatchBaselinesRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_patch_baselines(**kwargs)
describe_patch_group_state
Returns high-level aggregated patch compliance state information for a patch group.
Type annotations and code completion for boto3.client("ssm").describe_patch_group_state
method.
boto3 documentation
def describe_patch_group_state(
self,
*,
PatchGroup: str,
) -> DescribePatchGroupStateResultTypeDef: # (1)
...
kwargs: DescribePatchGroupStateRequestRequestTypeDef = { # (1)
"PatchGroup": ...,
}
parent.describe_patch_group_state(**kwargs)
describe_patch_groups
Lists all patch groups that have been registered with patch baselines.
Type annotations and code completion for boto3.client("ssm").describe_patch_groups
method.
boto3 documentation
def describe_patch_groups(
self,
*,
MaxResults: int = ...,
Filters: Sequence[PatchOrchestratorFilterTypeDef] = ..., # (1)
NextToken: str = ...,
) -> DescribePatchGroupsResultTypeDef: # (2)
...
kwargs: DescribePatchGroupsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.describe_patch_groups(**kwargs)
describe_patch_properties
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches.
Type annotations and code completion for boto3.client("ssm").describe_patch_properties
method.
boto3 documentation
def describe_patch_properties(
self,
*,
OperatingSystem: OperatingSystemType, # (1)
Property: PatchPropertyType, # (2)
PatchSet: PatchSetType = ..., # (3)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribePatchPropertiesResultTypeDef: # (4)
...
- See OperatingSystemType
- See PatchPropertyType
- See PatchSetType
- See DescribePatchPropertiesResultTypeDef
kwargs: DescribePatchPropertiesRequestRequestTypeDef = { # (1)
"OperatingSystem": ...,
"Property": ...,
}
parent.describe_patch_properties(**kwargs)
describe_sessions
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
Type annotations and code completion for boto3.client("ssm").describe_sessions
method.
boto3 documentation
def describe_sessions(
self,
*,
State: SessionStateType, # (1)
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[SessionFilterTypeDef] = ..., # (2)
) -> DescribeSessionsResponseTypeDef: # (3)
...
kwargs: DescribeSessionsRequestRequestTypeDef = { # (1)
"State": ...,
}
parent.describe_sessions(**kwargs)
disassociate_ops_item_related_item
Deletes the association between an OpsItem and a related item.
Type annotations and code completion for boto3.client("ssm").disassociate_ops_item_related_item
method.
boto3 documentation
def disassociate_ops_item_related_item(
self,
*,
OpsItemId: str,
AssociationId: str,
) -> Dict[str, Any]:
...
kwargs: DisassociateOpsItemRelatedItemRequestRequestTypeDef = { # (1)
"OpsItemId": ...,
"AssociationId": ...,
}
parent.disassociate_ops_item_related_item(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("ssm").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_automation_execution
Get detailed information about a particular Automation execution.
Type annotations and code completion for boto3.client("ssm").get_automation_execution
method.
boto3 documentation
def get_automation_execution(
self,
*,
AutomationExecutionId: str,
) -> GetAutomationExecutionResultTypeDef: # (1)
...
kwargs: GetAutomationExecutionRequestRequestTypeDef = { # (1)
"AutomationExecutionId": ...,
}
parent.get_automation_execution(**kwargs)
get_calendar_state
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
Type annotations and code completion for boto3.client("ssm").get_calendar_state
method.
boto3 documentation
def get_calendar_state(
self,
*,
CalendarNames: Sequence[str],
AtTime: str = ...,
) -> GetCalendarStateResponseTypeDef: # (1)
...
kwargs: GetCalendarStateRequestRequestTypeDef = { # (1)
"CalendarNames": ...,
}
parent.get_calendar_state(**kwargs)
get_command_invocation
Returns detailed information about command execution for an invocation or plugin.
Type annotations and code completion for boto3.client("ssm").get_command_invocation
method.
boto3 documentation
def get_command_invocation(
self,
*,
CommandId: str,
InstanceId: str,
PluginName: str = ...,
) -> GetCommandInvocationResultTypeDef: # (1)
...
kwargs: GetCommandInvocationRequestRequestTypeDef = { # (1)
"CommandId": ...,
"InstanceId": ...,
}
parent.get_command_invocation(**kwargs)
get_connection_status
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
Type annotations and code completion for boto3.client("ssm").get_connection_status
method.
boto3 documentation
def get_connection_status(
self,
*,
Target: str,
) -> GetConnectionStatusResponseTypeDef: # (1)
...
kwargs: GetConnectionStatusRequestRequestTypeDef = { # (1)
"Target": ...,
}
parent.get_connection_status(**kwargs)
get_default_patch_baseline
Retrieves the default patch baseline.
Type annotations and code completion for boto3.client("ssm").get_default_patch_baseline
method.
boto3 documentation
def get_default_patch_baseline(
self,
*,
OperatingSystem: OperatingSystemType = ..., # (1)
) -> GetDefaultPatchBaselineResultTypeDef: # (2)
...
kwargs: GetDefaultPatchBaselineRequestRequestTypeDef = { # (1)
"OperatingSystem": ...,
}
parent.get_default_patch_baseline(**kwargs)
get_deployable_patch_snapshot_for_instance
Retrieves the current snapshot for the patch baseline the managed node uses.
Type annotations and code completion for boto3.client("ssm").get_deployable_patch_snapshot_for_instance
method.
boto3 documentation
def get_deployable_patch_snapshot_for_instance(
self,
*,
InstanceId: str,
SnapshotId: str,
BaselineOverride: BaselineOverrideTypeDef = ..., # (1)
) -> GetDeployablePatchSnapshotForInstanceResultTypeDef: # (2)
...
kwargs: GetDeployablePatchSnapshotForInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"SnapshotId": ...,
}
parent.get_deployable_patch_snapshot_for_instance(**kwargs)
get_document
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
Type annotations and code completion for boto3.client("ssm").get_document
method.
boto3 documentation
def get_document(
self,
*,
Name: str,
VersionName: str = ...,
DocumentVersion: str = ...,
DocumentFormat: DocumentFormatType = ..., # (1)
) -> GetDocumentResultTypeDef: # (2)
...
kwargs: GetDocumentRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_document(**kwargs)
get_inventory
Query inventory information.
Type annotations and code completion for boto3.client("ssm").get_inventory
method.
boto3 documentation
def get_inventory(
self,
*,
Filters: Sequence[InventoryFilterTypeDef] = ..., # (1)
Aggregators: Sequence[InventoryAggregatorTypeDef] = ..., # (2)
ResultAttributes: Sequence[ResultAttributeTypeDef] = ..., # (3)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetInventoryResultTypeDef: # (4)
...
- See InventoryFilterTypeDef
- See InventoryAggregatorTypeDef
- See ResultAttributeTypeDef
- See GetInventoryResultTypeDef
kwargs: GetInventoryRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.get_inventory(**kwargs)
get_inventory_schema
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
Type annotations and code completion for boto3.client("ssm").get_inventory_schema
method.
boto3 documentation
def get_inventory_schema(
self,
*,
TypeName: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
Aggregator: bool = ...,
SubType: bool = ...,
) -> GetInventorySchemaResultTypeDef: # (1)
...
kwargs: GetInventorySchemaRequestRequestTypeDef = { # (1)
"TypeName": ...,
}
parent.get_inventory_schema(**kwargs)
get_maintenance_window
Retrieves a maintenance window.
Type annotations and code completion for boto3.client("ssm").get_maintenance_window
method.
boto3 documentation
def get_maintenance_window(
self,
*,
WindowId: str,
) -> GetMaintenanceWindowResultTypeDef: # (1)
...
kwargs: GetMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.get_maintenance_window(**kwargs)
get_maintenance_window_execution
Retrieves details about a specific a maintenance window execution.
Type annotations and code completion for boto3.client("ssm").get_maintenance_window_execution
method.
boto3 documentation
def get_maintenance_window_execution(
self,
*,
WindowExecutionId: str,
) -> GetMaintenanceWindowExecutionResultTypeDef: # (1)
...
kwargs: GetMaintenanceWindowExecutionRequestRequestTypeDef = { # (1)
"WindowExecutionId": ...,
}
parent.get_maintenance_window_execution(**kwargs)
get_maintenance_window_execution_task
Retrieves the details about a specific task run as part of a maintenance window execution.
Type annotations and code completion for boto3.client("ssm").get_maintenance_window_execution_task
method.
boto3 documentation
def get_maintenance_window_execution_task(
self,
*,
WindowExecutionId: str,
TaskId: str,
) -> GetMaintenanceWindowExecutionTaskResultTypeDef: # (1)
...
kwargs: GetMaintenanceWindowExecutionTaskRequestRequestTypeDef = { # (1)
"WindowExecutionId": ...,
"TaskId": ...,
}
parent.get_maintenance_window_execution_task(**kwargs)
get_maintenance_window_execution_task_invocation
Retrieves information about a specific task running on a specific target.
Type annotations and code completion for boto3.client("ssm").get_maintenance_window_execution_task_invocation
method.
boto3 documentation
def get_maintenance_window_execution_task_invocation(
self,
*,
WindowExecutionId: str,
TaskId: str,
InvocationId: str,
) -> GetMaintenanceWindowExecutionTaskInvocationResultTypeDef: # (1)
...
kwargs: GetMaintenanceWindowExecutionTaskInvocationRequestRequestTypeDef = { # (1)
"WindowExecutionId": ...,
"TaskId": ...,
"InvocationId": ...,
}
parent.get_maintenance_window_execution_task_invocation(**kwargs)
get_maintenance_window_task
Retrieves the details of a maintenance window task.
Type annotations and code completion for boto3.client("ssm").get_maintenance_window_task
method.
boto3 documentation
def get_maintenance_window_task(
self,
*,
WindowId: str,
WindowTaskId: str,
) -> GetMaintenanceWindowTaskResultTypeDef: # (1)
...
kwargs: GetMaintenanceWindowTaskRequestRequestTypeDef = { # (1)
"WindowId": ...,
"WindowTaskId": ...,
}
parent.get_maintenance_window_task(**kwargs)
get_ops_item
Get information about an OpsItem by using the ID.
Type annotations and code completion for boto3.client("ssm").get_ops_item
method.
boto3 documentation
def get_ops_item(
self,
*,
OpsItemId: str,
OpsItemArn: str = ...,
) -> GetOpsItemResponseTypeDef: # (1)
...
kwargs: GetOpsItemRequestRequestTypeDef = { # (1)
"OpsItemId": ...,
}
parent.get_ops_item(**kwargs)
get_ops_metadata
View operational metadata related to an application in Application Manager.
Type annotations and code completion for boto3.client("ssm").get_ops_metadata
method.
boto3 documentation
def get_ops_metadata(
self,
*,
OpsMetadataArn: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetOpsMetadataResultTypeDef: # (1)
...
kwargs: GetOpsMetadataRequestRequestTypeDef = { # (1)
"OpsMetadataArn": ...,
}
parent.get_ops_metadata(**kwargs)
get_ops_summary
View a summary of operations metadata (OpsData) based on specified filters and aggregators.
Type annotations and code completion for boto3.client("ssm").get_ops_summary
method.
boto3 documentation
def get_ops_summary(
self,
*,
SyncName: str = ...,
Filters: Sequence[OpsFilterTypeDef] = ..., # (1)
Aggregators: Sequence[OpsAggregatorTypeDef] = ..., # (2)
ResultAttributes: Sequence[OpsResultAttributeTypeDef] = ..., # (3)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetOpsSummaryResultTypeDef: # (4)
...
- See OpsFilterTypeDef
- See OpsAggregatorTypeDef
- See OpsResultAttributeTypeDef
- See GetOpsSummaryResultTypeDef
kwargs: GetOpsSummaryRequestRequestTypeDef = { # (1)
"SyncName": ...,
}
parent.get_ops_summary(**kwargs)
get_parameter
Get information about a single parameter by specifying the parameter name.
Type annotations and code completion for boto3.client("ssm").get_parameter
method.
boto3 documentation
def get_parameter(
self,
*,
Name: str,
WithDecryption: bool = ...,
) -> GetParameterResultTypeDef: # (1)
...
kwargs: GetParameterRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_parameter(**kwargs)
get_parameter_history
Retrieves the history of all changes to a parameter.
Type annotations and code completion for boto3.client("ssm").get_parameter_history
method.
boto3 documentation
def get_parameter_history(
self,
*,
Name: str,
WithDecryption: bool = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetParameterHistoryResultTypeDef: # (1)
...
kwargs: GetParameterHistoryRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_parameter_history(**kwargs)
get_parameters
Get information about one or more parameters by specifying multiple parameter names.
Type annotations and code completion for boto3.client("ssm").get_parameters
method.
boto3 documentation
def get_parameters(
self,
*,
Names: Sequence[str],
WithDecryption: bool = ...,
) -> GetParametersResultTypeDef: # (1)
...
kwargs: GetParametersRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.get_parameters(**kwargs)
get_parameters_by_path
Retrieve information about one or more parameters in a specific hierarchy.
Type annotations and code completion for boto3.client("ssm").get_parameters_by_path
method.
boto3 documentation
def get_parameters_by_path(
self,
*,
Path: str,
Recursive: bool = ...,
ParameterFilters: Sequence[ParameterStringFilterTypeDef] = ..., # (1)
WithDecryption: bool = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetParametersByPathResultTypeDef: # (2)
...
kwargs: GetParametersByPathRequestRequestTypeDef = { # (1)
"Path": ...,
}
parent.get_parameters_by_path(**kwargs)
get_patch_baseline
Retrieves information about a patch baseline.
Type annotations and code completion for boto3.client("ssm").get_patch_baseline
method.
boto3 documentation
def get_patch_baseline(
self,
*,
BaselineId: str,
) -> GetPatchBaselineResultTypeDef: # (1)
...
kwargs: GetPatchBaselineRequestRequestTypeDef = { # (1)
"BaselineId": ...,
}
parent.get_patch_baseline(**kwargs)
get_patch_baseline_for_patch_group
Retrieves the patch baseline that should be used for the specified patch group.
Type annotations and code completion for boto3.client("ssm").get_patch_baseline_for_patch_group
method.
boto3 documentation
def get_patch_baseline_for_patch_group(
self,
*,
PatchGroup: str,
OperatingSystem: OperatingSystemType = ..., # (1)
) -> GetPatchBaselineForPatchGroupResultTypeDef: # (2)
...
kwargs: GetPatchBaselineForPatchGroupRequestRequestTypeDef = { # (1)
"PatchGroup": ...,
}
parent.get_patch_baseline_for_patch_group(**kwargs)
get_resource_policies
Returns an array of the Policy
object.
Type annotations and code completion for boto3.client("ssm").get_resource_policies
method.
boto3 documentation
def get_resource_policies(
self,
*,
ResourceArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetResourcePoliciesResponseTypeDef: # (1)
...
kwargs: GetResourcePoliciesRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_resource_policies(**kwargs)
get_service_setting
ServiceSetting
is an account-level setting for an Amazon Web Services service.
Type annotations and code completion for boto3.client("ssm").get_service_setting
method.
boto3 documentation
def get_service_setting(
self,
*,
SettingId: str,
) -> GetServiceSettingResultTypeDef: # (1)
...
kwargs: GetServiceSettingRequestRequestTypeDef = { # (1)
"SettingId": ...,
}
parent.get_service_setting(**kwargs)
label_parameter_version
A parameter label is a user-defined alias to help you manage different versions of a parameter.
Type annotations and code completion for boto3.client("ssm").label_parameter_version
method.
boto3 documentation
def label_parameter_version(
self,
*,
Name: str,
Labels: Sequence[str],
ParameterVersion: int = ...,
) -> LabelParameterVersionResultTypeDef: # (1)
...
kwargs: LabelParameterVersionRequestRequestTypeDef = { # (1)
"Name": ...,
"Labels": ...,
}
parent.label_parameter_version(**kwargs)
list_association_versions
Retrieves all versions of an association for a specific association ID.
Type annotations and code completion for boto3.client("ssm").list_association_versions
method.
boto3 documentation
def list_association_versions(
self,
*,
AssociationId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAssociationVersionsResultTypeDef: # (1)
...
kwargs: ListAssociationVersionsRequestRequestTypeDef = { # (1)
"AssociationId": ...,
}
parent.list_association_versions(**kwargs)
list_associations
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
Type annotations and code completion for boto3.client("ssm").list_associations
method.
boto3 documentation
def list_associations(
self,
*,
AssociationFilterList: Sequence[AssociationFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAssociationsResultTypeDef: # (2)
...
kwargs: ListAssociationsRequestRequestTypeDef = { # (1)
"AssociationFilterList": ...,
}
parent.list_associations(**kwargs)
list_command_invocations
An invocation is copy of a command sent to a specific managed node.
Type annotations and code completion for boto3.client("ssm").list_command_invocations
method.
boto3 documentation
def list_command_invocations(
self,
*,
CommandId: str = ...,
InstanceId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[CommandFilterTypeDef] = ..., # (1)
Details: bool = ...,
) -> ListCommandInvocationsResultTypeDef: # (2)
...
kwargs: ListCommandInvocationsRequestRequestTypeDef = { # (1)
"CommandId": ...,
}
parent.list_command_invocations(**kwargs)
list_commands
Lists the commands requested by users of the Amazon Web Services account.
Type annotations and code completion for boto3.client("ssm").list_commands
method.
boto3 documentation
def list_commands(
self,
*,
CommandId: str = ...,
InstanceId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[CommandFilterTypeDef] = ..., # (1)
) -> ListCommandsResultTypeDef: # (2)
...
kwargs: ListCommandsRequestRequestTypeDef = { # (1)
"CommandId": ...,
}
parent.list_commands(**kwargs)
list_compliance_items
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types.
Type annotations and code completion for boto3.client("ssm").list_compliance_items
method.
boto3 documentation
def list_compliance_items(
self,
*,
Filters: Sequence[ComplianceStringFilterTypeDef] = ..., # (1)
ResourceIds: Sequence[str] = ...,
ResourceTypes: Sequence[str] = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListComplianceItemsResultTypeDef: # (2)
...
kwargs: ListComplianceItemsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_compliance_items(**kwargs)
list_compliance_summaries
Returns a summary count of compliant and non-compliant resources for a compliance type.
Type annotations and code completion for boto3.client("ssm").list_compliance_summaries
method.
boto3 documentation
def list_compliance_summaries(
self,
*,
Filters: Sequence[ComplianceStringFilterTypeDef] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListComplianceSummariesResultTypeDef: # (2)
...
kwargs: ListComplianceSummariesRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_compliance_summaries(**kwargs)
list_document_metadata_history
Information about approval reviews for a version of a change template in Change Manager.
Type annotations and code completion for boto3.client("ssm").list_document_metadata_history
method.
boto3 documentation
def list_document_metadata_history(
self,
*,
Name: str,
Metadata: DocumentMetadataEnumType, # (1)
DocumentVersion: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDocumentMetadataHistoryResponseTypeDef: # (2)
...
kwargs: ListDocumentMetadataHistoryRequestRequestTypeDef = { # (1)
"Name": ...,
"Metadata": ...,
}
parent.list_document_metadata_history(**kwargs)
list_document_versions
List all versions for a document.
Type annotations and code completion for boto3.client("ssm").list_document_versions
method.
boto3 documentation
def list_document_versions(
self,
*,
Name: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDocumentVersionsResultTypeDef: # (1)
...
kwargs: ListDocumentVersionsRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.list_document_versions(**kwargs)
list_documents
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.
Type annotations and code completion for boto3.client("ssm").list_documents
method.
boto3 documentation
def list_documents(
self,
*,
DocumentFilterList: Sequence[DocumentFilterTypeDef] = ..., # (1)
Filters: Sequence[DocumentKeyValuesFilterTypeDef] = ..., # (2)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDocumentsResultTypeDef: # (3)
...
kwargs: ListDocumentsRequestRequestTypeDef = { # (1)
"DocumentFilterList": ...,
}
parent.list_documents(**kwargs)
list_inventory_entries
A list of inventory items returned by the request.
Type annotations and code completion for boto3.client("ssm").list_inventory_entries
method.
boto3 documentation
def list_inventory_entries(
self,
*,
InstanceId: str,
TypeName: str,
Filters: Sequence[InventoryFilterTypeDef] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListInventoryEntriesResultTypeDef: # (2)
...
kwargs: ListInventoryEntriesRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"TypeName": ...,
}
parent.list_inventory_entries(**kwargs)
list_ops_item_events
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.
Type annotations and code completion for boto3.client("ssm").list_ops_item_events
method.
boto3 documentation
def list_ops_item_events(
self,
*,
Filters: Sequence[OpsItemEventFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListOpsItemEventsResponseTypeDef: # (2)
...
kwargs: ListOpsItemEventsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_ops_item_events(**kwargs)
list_ops_item_related_items
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
Type annotations and code completion for boto3.client("ssm").list_ops_item_related_items
method.
boto3 documentation
def list_ops_item_related_items(
self,
*,
OpsItemId: str = ...,
Filters: Sequence[OpsItemRelatedItemsFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListOpsItemRelatedItemsResponseTypeDef: # (2)
...
kwargs: ListOpsItemRelatedItemsRequestRequestTypeDef = { # (1)
"OpsItemId": ...,
}
parent.list_ops_item_related_items(**kwargs)
list_ops_metadata
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
Type annotations and code completion for boto3.client("ssm").list_ops_metadata
method.
boto3 documentation
def list_ops_metadata(
self,
*,
Filters: Sequence[OpsMetadataFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListOpsMetadataResultTypeDef: # (2)
...
kwargs: ListOpsMetadataRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_ops_metadata(**kwargs)
list_resource_compliance_summaries
Returns a resource-level summary count.
Type annotations and code completion for boto3.client("ssm").list_resource_compliance_summaries
method.
boto3 documentation
def list_resource_compliance_summaries(
self,
*,
Filters: Sequence[ComplianceStringFilterTypeDef] = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListResourceComplianceSummariesResultTypeDef: # (2)
...
kwargs: ListResourceComplianceSummariesRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_resource_compliance_summaries(**kwargs)
list_resource_data_sync
Lists your resource data sync configurations.
Type annotations and code completion for boto3.client("ssm").list_resource_data_sync
method.
boto3 documentation
def list_resource_data_sync(
self,
*,
SyncType: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListResourceDataSyncResultTypeDef: # (1)
...
kwargs: ListResourceDataSyncRequestRequestTypeDef = { # (1)
"SyncType": ...,
}
parent.list_resource_data_sync(**kwargs)
list_tags_for_resource
Returns a list of the tags assigned to the specified resource.
Type annotations and code completion for boto3.client("ssm").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceType: ResourceTypeForTaggingType, # (1)
ResourceId: str,
) -> ListTagsForResourceResultTypeDef: # (2)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
"ResourceId": ...,
}
parent.list_tags_for_resource(**kwargs)
modify_document_permission
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.
Type annotations and code completion for boto3.client("ssm").modify_document_permission
method.
boto3 documentation
def modify_document_permission(
self,
*,
Name: str,
PermissionType: DocumentPermissionTypeType, # (1)
AccountIdsToAdd: Sequence[str] = ...,
AccountIdsToRemove: Sequence[str] = ...,
SharedDocumentVersion: str = ...,
) -> Dict[str, Any]:
...
kwargs: ModifyDocumentPermissionRequestRequestTypeDef = { # (1)
"Name": ...,
"PermissionType": ...,
}
parent.modify_document_permission(**kwargs)
put_compliance_items
Registers a compliance type and other compliance details on a designated resource.
Type annotations and code completion for boto3.client("ssm").put_compliance_items
method.
boto3 documentation
def put_compliance_items(
self,
*,
ResourceId: str,
ResourceType: str,
ComplianceType: str,
ExecutionSummary: ComplianceExecutionSummaryTypeDef, # (1)
Items: Sequence[ComplianceItemEntryTypeDef], # (2)
ItemContentHash: str = ...,
UploadType: ComplianceUploadTypeType = ..., # (3)
) -> Dict[str, Any]:
...
kwargs: PutComplianceItemsRequestRequestTypeDef = { # (1)
"ResourceId": ...,
"ResourceType": ...,
"ComplianceType": ...,
"ExecutionSummary": ...,
"Items": ...,
}
parent.put_compliance_items(**kwargs)
put_inventory
Bulk update custom inventory items on one or more managed nodes.
Type annotations and code completion for boto3.client("ssm").put_inventory
method.
boto3 documentation
def put_inventory(
self,
*,
InstanceId: str,
Items: Sequence[InventoryItemTypeDef], # (1)
) -> PutInventoryResultTypeDef: # (2)
...
kwargs: PutInventoryRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"Items": ...,
}
parent.put_inventory(**kwargs)
put_parameter
Add a parameter to the system.
Type annotations and code completion for boto3.client("ssm").put_parameter
method.
boto3 documentation
def put_parameter(
self,
*,
Name: str,
Value: str,
Description: str = ...,
Type: ParameterTypeType = ..., # (1)
KeyId: str = ...,
Overwrite: bool = ...,
AllowedPattern: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
Tier: ParameterTierType = ..., # (3)
Policies: str = ...,
DataType: str = ...,
) -> PutParameterResultTypeDef: # (4)
...
- See ParameterTypeType
- See TagTypeDef
- See ParameterTierType
- See PutParameterResultTypeDef
kwargs: PutParameterRequestRequestTypeDef = { # (1)
"Name": ...,
"Value": ...,
}
parent.put_parameter(**kwargs)
put_resource_policy
Creates or updates a Systems Manager resource policy.
Type annotations and code completion for boto3.client("ssm").put_resource_policy
method.
boto3 documentation
def put_resource_policy(
self,
*,
ResourceArn: str,
Policy: str,
PolicyId: str = ...,
PolicyHash: str = ...,
) -> PutResourcePolicyResponseTypeDef: # (1)
...
kwargs: PutResourcePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Policy": ...,
}
parent.put_resource_policy(**kwargs)
register_default_patch_baseline
Defines the default patch baseline for the relevant operating system.
Type annotations and code completion for boto3.client("ssm").register_default_patch_baseline
method.
boto3 documentation
def register_default_patch_baseline(
self,
*,
BaselineId: str,
) -> RegisterDefaultPatchBaselineResultTypeDef: # (1)
...
kwargs: RegisterDefaultPatchBaselineRequestRequestTypeDef = { # (1)
"BaselineId": ...,
}
parent.register_default_patch_baseline(**kwargs)
register_patch_baseline_for_patch_group
Registers a patch baseline for a patch group.
Type annotations and code completion for boto3.client("ssm").register_patch_baseline_for_patch_group
method.
boto3 documentation
def register_patch_baseline_for_patch_group(
self,
*,
BaselineId: str,
PatchGroup: str,
) -> RegisterPatchBaselineForPatchGroupResultTypeDef: # (1)
...
kwargs: RegisterPatchBaselineForPatchGroupRequestRequestTypeDef = { # (1)
"BaselineId": ...,
"PatchGroup": ...,
}
parent.register_patch_baseline_for_patch_group(**kwargs)
register_target_with_maintenance_window
Registers a target with a maintenance window.
Type annotations and code completion for boto3.client("ssm").register_target_with_maintenance_window
method.
boto3 documentation
def register_target_with_maintenance_window(
self,
*,
WindowId: str,
ResourceType: MaintenanceWindowResourceTypeType, # (1)
Targets: Sequence[TargetTypeDef], # (2)
OwnerInformation: str = ...,
Name: str = ...,
Description: str = ...,
ClientToken: str = ...,
) -> RegisterTargetWithMaintenanceWindowResultTypeDef: # (3)
...
- See MaintenanceWindowResourceTypeType
- See TargetTypeDef
- See RegisterTargetWithMaintenanceWindowResultTypeDef
kwargs: RegisterTargetWithMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
"ResourceType": ...,
"Targets": ...,
}
parent.register_target_with_maintenance_window(**kwargs)
register_task_with_maintenance_window
Adds a new task to a maintenance window.
Type annotations and code completion for boto3.client("ssm").register_task_with_maintenance_window
method.
boto3 documentation
def register_task_with_maintenance_window(
self,
*,
WindowId: str,
TaskArn: str,
TaskType: MaintenanceWindowTaskTypeType, # (1)
Targets: Sequence[TargetTypeDef] = ..., # (2)
ServiceRoleArn: str = ...,
TaskParameters: Mapping[str, MaintenanceWindowTaskParameterValueExpressionTypeDef] = ..., # (3)
TaskInvocationParameters: MaintenanceWindowTaskInvocationParametersTypeDef = ..., # (4)
Priority: int = ...,
MaxConcurrency: str = ...,
MaxErrors: str = ...,
LoggingInfo: LoggingInfoTypeDef = ..., # (5)
Name: str = ...,
Description: str = ...,
ClientToken: str = ...,
CutoffBehavior: MaintenanceWindowTaskCutoffBehaviorType = ..., # (6)
AlarmConfiguration: AlarmConfigurationTypeDef = ..., # (7)
) -> RegisterTaskWithMaintenanceWindowResultTypeDef: # (8)
...
- See MaintenanceWindowTaskTypeType
- See TargetTypeDef
- See MaintenanceWindowTaskParameterValueExpressionTypeDef
- See MaintenanceWindowTaskInvocationParametersTypeDef
- See LoggingInfoTypeDef
- See MaintenanceWindowTaskCutoffBehaviorType
- See AlarmConfigurationTypeDef
- See RegisterTaskWithMaintenanceWindowResultTypeDef
kwargs: RegisterTaskWithMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
"TaskArn": ...,
"TaskType": ...,
}
parent.register_task_with_maintenance_window(**kwargs)
remove_tags_from_resource
Removes tag keys from the specified resource.
Type annotations and code completion for boto3.client("ssm").remove_tags_from_resource
method.
boto3 documentation
def remove_tags_from_resource(
self,
*,
ResourceType: ResourceTypeForTaggingType, # (1)
ResourceId: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: RemoveTagsFromResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
"ResourceId": ...,
"TagKeys": ...,
}
parent.remove_tags_from_resource(**kwargs)
reset_service_setting
ServiceSetting
is an account-level setting for an Amazon Web Services service.
Type annotations and code completion for boto3.client("ssm").reset_service_setting
method.
boto3 documentation
def reset_service_setting(
self,
*,
SettingId: str,
) -> ResetServiceSettingResultTypeDef: # (1)
...
kwargs: ResetServiceSettingRequestRequestTypeDef = { # (1)
"SettingId": ...,
}
parent.reset_service_setting(**kwargs)
resume_session
Reconnects a session to a managed node after it has been disconnected.
Type annotations and code completion for boto3.client("ssm").resume_session
method.
boto3 documentation
def resume_session(
self,
*,
SessionId: str,
) -> ResumeSessionResponseTypeDef: # (1)
...
kwargs: ResumeSessionRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.resume_session(**kwargs)
send_automation_signal
Sends a signal to an Automation execution to change the current behavior or status of the execution.
Type annotations and code completion for boto3.client("ssm").send_automation_signal
method.
boto3 documentation
def send_automation_signal(
self,
*,
AutomationExecutionId: str,
SignalType: SignalTypeType, # (1)
Payload: Mapping[str, Sequence[str]] = ...,
) -> Dict[str, Any]:
...
- See SignalTypeType
kwargs: SendAutomationSignalRequestRequestTypeDef = { # (1)
"AutomationExecutionId": ...,
"SignalType": ...,
}
parent.send_automation_signal(**kwargs)
send_command
Runs commands on one or more managed nodes.
Type annotations and code completion for boto3.client("ssm").send_command
method.
boto3 documentation
def send_command(
self,
*,
DocumentName: str,
InstanceIds: Sequence[str] = ...,
Targets: Sequence[TargetTypeDef] = ..., # (1)
DocumentVersion: str = ...,
DocumentHash: str = ...,
DocumentHashType: DocumentHashTypeType = ..., # (2)
TimeoutSeconds: int = ...,
Comment: str = ...,
Parameters: Mapping[str, Sequence[str]] = ...,
OutputS3Region: str = ...,
OutputS3BucketName: str = ...,
OutputS3KeyPrefix: str = ...,
MaxConcurrency: str = ...,
MaxErrors: str = ...,
ServiceRoleArn: str = ...,
NotificationConfig: NotificationConfigTypeDef = ..., # (3)
CloudWatchOutputConfig: CloudWatchOutputConfigTypeDef = ..., # (4)
AlarmConfiguration: AlarmConfigurationTypeDef = ..., # (5)
) -> SendCommandResultTypeDef: # (6)
...
- See TargetTypeDef
- See DocumentHashTypeType
- See NotificationConfigTypeDef
- See CloudWatchOutputConfigTypeDef
- See AlarmConfigurationTypeDef
- See SendCommandResultTypeDef
kwargs: SendCommandRequestRequestTypeDef = { # (1)
"DocumentName": ...,
}
parent.send_command(**kwargs)
start_associations_once
Runs an association immediately and only one time.
Type annotations and code completion for boto3.client("ssm").start_associations_once
method.
boto3 documentation
def start_associations_once(
self,
*,
AssociationIds: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: StartAssociationsOnceRequestRequestTypeDef = { # (1)
"AssociationIds": ...,
}
parent.start_associations_once(**kwargs)
start_automation_execution
Initiates execution of an Automation runbook.
Type annotations and code completion for boto3.client("ssm").start_automation_execution
method.
boto3 documentation
def start_automation_execution(
self,
*,
DocumentName: str,
DocumentVersion: str = ...,
Parameters: Mapping[str, Sequence[str]] = ...,
ClientToken: str = ...,
Mode: ExecutionModeType = ..., # (1)
TargetParameterName: str = ...,
Targets: Sequence[TargetTypeDef] = ..., # (2)
TargetMaps: Sequence[Mapping[str, Sequence[str]]] = ...,
MaxConcurrency: str = ...,
MaxErrors: str = ...,
TargetLocations: Sequence[TargetLocationTypeDef] = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
AlarmConfiguration: AlarmConfigurationTypeDef = ..., # (5)
) -> StartAutomationExecutionResultTypeDef: # (6)
...
- See ExecutionModeType
- See TargetTypeDef
- See TargetLocationTypeDef
- See TagTypeDef
- See AlarmConfigurationTypeDef
- See StartAutomationExecutionResultTypeDef
kwargs: StartAutomationExecutionRequestRequestTypeDef = { # (1)
"DocumentName": ...,
}
parent.start_automation_execution(**kwargs)
start_change_request_execution
Creates a change request for Change Manager.
Type annotations and code completion for boto3.client("ssm").start_change_request_execution
method.
boto3 documentation
def start_change_request_execution(
self,
*,
DocumentName: str,
Runbooks: Sequence[RunbookTypeDef], # (1)
ScheduledTime: Union[datetime, str] = ...,
DocumentVersion: str = ...,
Parameters: Mapping[str, Sequence[str]] = ...,
ChangeRequestName: str = ...,
ClientToken: str = ...,
AutoApprove: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
ScheduledEndTime: Union[datetime, str] = ...,
ChangeDetails: str = ...,
) -> StartChangeRequestExecutionResultTypeDef: # (3)
...
kwargs: StartChangeRequestExecutionRequestRequestTypeDef = { # (1)
"DocumentName": ...,
"Runbooks": ...,
}
parent.start_change_request_execution(**kwargs)
start_session
Initiates a connection to a target (for example, a managed node) for a Session Manager session.
Type annotations and code completion for boto3.client("ssm").start_session
method.
boto3 documentation
def start_session(
self,
*,
Target: str,
DocumentName: str = ...,
Reason: str = ...,
Parameters: Mapping[str, Sequence[str]] = ...,
) -> StartSessionResponseTypeDef: # (1)
...
kwargs: StartSessionRequestRequestTypeDef = { # (1)
"Target": ...,
}
parent.start_session(**kwargs)
stop_automation_execution
Stop an Automation that is currently running.
Type annotations and code completion for boto3.client("ssm").stop_automation_execution
method.
boto3 documentation
def stop_automation_execution(
self,
*,
AutomationExecutionId: str,
Type: StopTypeType = ..., # (1)
) -> Dict[str, Any]:
...
- See StopTypeType
kwargs: StopAutomationExecutionRequestRequestTypeDef = { # (1)
"AutomationExecutionId": ...,
}
parent.stop_automation_execution(**kwargs)
terminate_session
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node.
Type annotations and code completion for boto3.client("ssm").terminate_session
method.
boto3 documentation
def terminate_session(
self,
*,
SessionId: str,
) -> TerminateSessionResponseTypeDef: # (1)
...
kwargs: TerminateSessionRequestRequestTypeDef = { # (1)
"SessionId": ...,
}
parent.terminate_session(**kwargs)
unlabel_parameter_version
Remove a label or labels from a parameter.
Type annotations and code completion for boto3.client("ssm").unlabel_parameter_version
method.
boto3 documentation
def unlabel_parameter_version(
self,
*,
Name: str,
ParameterVersion: int,
Labels: Sequence[str],
) -> UnlabelParameterVersionResultTypeDef: # (1)
...
kwargs: UnlabelParameterVersionRequestRequestTypeDef = { # (1)
"Name": ...,
"ParameterVersion": ...,
"Labels": ...,
}
parent.unlabel_parameter_version(**kwargs)
update_association
Updates an association.
Type annotations and code completion for boto3.client("ssm").update_association
method.
boto3 documentation
def update_association(
self,
*,
AssociationId: str,
Parameters: Mapping[str, Sequence[str]] = ...,
DocumentVersion: str = ...,
ScheduleExpression: str = ...,
OutputLocation: InstanceAssociationOutputLocationTypeDef = ..., # (1)
Name: str = ...,
Targets: Sequence[TargetTypeDef] = ..., # (2)
AssociationName: str = ...,
AssociationVersion: str = ...,
AutomationTargetParameterName: str = ...,
MaxErrors: str = ...,
MaxConcurrency: str = ...,
ComplianceSeverity: AssociationComplianceSeverityType = ..., # (3)
SyncCompliance: AssociationSyncComplianceType = ..., # (4)
ApplyOnlyAtCronInterval: bool = ...,
CalendarNames: Sequence[str] = ...,
TargetLocations: Sequence[TargetLocationTypeDef] = ..., # (5)
ScheduleOffset: int = ...,
TargetMaps: Sequence[Mapping[str, Sequence[str]]] = ...,
AlarmConfiguration: AlarmConfigurationTypeDef = ..., # (6)
) -> UpdateAssociationResultTypeDef: # (7)
...
- See InstanceAssociationOutputLocationTypeDef
- See TargetTypeDef
- See AssociationComplianceSeverityType
- See AssociationSyncComplianceType
- See TargetLocationTypeDef
- See AlarmConfigurationTypeDef
- See UpdateAssociationResultTypeDef
kwargs: UpdateAssociationRequestRequestTypeDef = { # (1)
"AssociationId": ...,
}
parent.update_association(**kwargs)
update_association_status
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
Type annotations and code completion for boto3.client("ssm").update_association_status
method.
boto3 documentation
def update_association_status(
self,
*,
Name: str,
InstanceId: str,
AssociationStatus: AssociationStatusTypeDef, # (1)
) -> UpdateAssociationStatusResultTypeDef: # (2)
...
kwargs: UpdateAssociationStatusRequestRequestTypeDef = { # (1)
"Name": ...,
"InstanceId": ...,
"AssociationStatus": ...,
}
parent.update_association_status(**kwargs)
update_document
Updates one or more values for an SSM document.
Type annotations and code completion for boto3.client("ssm").update_document
method.
boto3 documentation
def update_document(
self,
*,
Content: str,
Name: str,
Attachments: Sequence[AttachmentsSourceTypeDef] = ..., # (1)
DisplayName: str = ...,
VersionName: str = ...,
DocumentVersion: str = ...,
DocumentFormat: DocumentFormatType = ..., # (2)
TargetType: str = ...,
) -> UpdateDocumentResultTypeDef: # (3)
...
kwargs: UpdateDocumentRequestRequestTypeDef = { # (1)
"Content": ...,
"Name": ...,
}
parent.update_document(**kwargs)
update_document_default_version
Set the default version of a document.
Type annotations and code completion for boto3.client("ssm").update_document_default_version
method.
boto3 documentation
def update_document_default_version(
self,
*,
Name: str,
DocumentVersion: str,
) -> UpdateDocumentDefaultVersionResultTypeDef: # (1)
...
kwargs: UpdateDocumentDefaultVersionRequestRequestTypeDef = { # (1)
"Name": ...,
"DocumentVersion": ...,
}
parent.update_document_default_version(**kwargs)
update_document_metadata
Updates information related to approval reviews for a specific version of a change template in Change Manager.
Type annotations and code completion for boto3.client("ssm").update_document_metadata
method.
boto3 documentation
def update_document_metadata(
self,
*,
Name: str,
DocumentReviews: DocumentReviewsTypeDef, # (1)
DocumentVersion: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateDocumentMetadataRequestRequestTypeDef = { # (1)
"Name": ...,
"DocumentReviews": ...,
}
parent.update_document_metadata(**kwargs)
update_maintenance_window
Updates an existing maintenance window.
Type annotations and code completion for boto3.client("ssm").update_maintenance_window
method.
boto3 documentation
def update_maintenance_window(
self,
*,
WindowId: str,
Name: str = ...,
Description: str = ...,
StartDate: str = ...,
EndDate: str = ...,
Schedule: str = ...,
ScheduleTimezone: str = ...,
ScheduleOffset: int = ...,
Duration: int = ...,
Cutoff: int = ...,
AllowUnassociatedTargets: bool = ...,
Enabled: bool = ...,
Replace: bool = ...,
) -> UpdateMaintenanceWindowResultTypeDef: # (1)
...
kwargs: UpdateMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.update_maintenance_window(**kwargs)
update_maintenance_window_target
Modifies the target of an existing maintenance window.
Type annotations and code completion for boto3.client("ssm").update_maintenance_window_target
method.
boto3 documentation
def update_maintenance_window_target(
self,
*,
WindowId: str,
WindowTargetId: str,
Targets: Sequence[TargetTypeDef] = ..., # (1)
OwnerInformation: str = ...,
Name: str = ...,
Description: str = ...,
Replace: bool = ...,
) -> UpdateMaintenanceWindowTargetResultTypeDef: # (2)
...
kwargs: UpdateMaintenanceWindowTargetRequestRequestTypeDef = { # (1)
"WindowId": ...,
"WindowTargetId": ...,
}
parent.update_maintenance_window_target(**kwargs)
update_maintenance_window_task
Modifies a task assigned to a maintenance window.
Type annotations and code completion for boto3.client("ssm").update_maintenance_window_task
method.
boto3 documentation
def update_maintenance_window_task(
self,
*,
WindowId: str,
WindowTaskId: str,
Targets: Sequence[TargetTypeDef] = ..., # (1)
TaskArn: str = ...,
ServiceRoleArn: str = ...,
TaskParameters: Mapping[str, MaintenanceWindowTaskParameterValueExpressionTypeDef] = ..., # (2)
TaskInvocationParameters: MaintenanceWindowTaskInvocationParametersTypeDef = ..., # (3)
Priority: int = ...,
MaxConcurrency: str = ...,
MaxErrors: str = ...,
LoggingInfo: LoggingInfoTypeDef = ..., # (4)
Name: str = ...,
Description: str = ...,
Replace: bool = ...,
CutoffBehavior: MaintenanceWindowTaskCutoffBehaviorType = ..., # (5)
AlarmConfiguration: AlarmConfigurationTypeDef = ..., # (6)
) -> UpdateMaintenanceWindowTaskResultTypeDef: # (7)
...
- See TargetTypeDef
- See MaintenanceWindowTaskParameterValueExpressionTypeDef
- See MaintenanceWindowTaskInvocationParametersTypeDef
- See LoggingInfoTypeDef
- See MaintenanceWindowTaskCutoffBehaviorType
- See AlarmConfigurationTypeDef
- See UpdateMaintenanceWindowTaskResultTypeDef
kwargs: UpdateMaintenanceWindowTaskRequestRequestTypeDef = { # (1)
"WindowId": ...,
"WindowTaskId": ...,
}
parent.update_maintenance_window_task(**kwargs)
update_managed_instance_role
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM).
Type annotations and code completion for boto3.client("ssm").update_managed_instance_role
method.
boto3 documentation
def update_managed_instance_role(
self,
*,
InstanceId: str,
IamRole: str,
) -> Dict[str, Any]:
...
kwargs: UpdateManagedInstanceRoleRequestRequestTypeDef = { # (1)
"InstanceId": ...,
"IamRole": ...,
}
parent.update_managed_instance_role(**kwargs)
update_ops_item
Edit or change an OpsItem.
Type annotations and code completion for boto3.client("ssm").update_ops_item
method.
boto3 documentation
def update_ops_item(
self,
*,
OpsItemId: str,
Description: str = ...,
OperationalData: Mapping[str, OpsItemDataValueTypeDef] = ..., # (1)
OperationalDataToDelete: Sequence[str] = ...,
Notifications: Sequence[OpsItemNotificationTypeDef] = ..., # (2)
Priority: int = ...,
RelatedOpsItems: Sequence[RelatedOpsItemTypeDef] = ..., # (3)
Status: OpsItemStatusType = ..., # (4)
Title: str = ...,
Category: str = ...,
Severity: str = ...,
ActualStartTime: Union[datetime, str] = ...,
ActualEndTime: Union[datetime, str] = ...,
PlannedStartTime: Union[datetime, str] = ...,
PlannedEndTime: Union[datetime, str] = ...,
OpsItemArn: str = ...,
) -> Dict[str, Any]:
...
- See OpsItemDataValueTypeDef
- See OpsItemNotificationTypeDef
- See RelatedOpsItemTypeDef
- See OpsItemStatusType
kwargs: UpdateOpsItemRequestRequestTypeDef = { # (1)
"OpsItemId": ...,
}
parent.update_ops_item(**kwargs)
update_ops_metadata
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
Type annotations and code completion for boto3.client("ssm").update_ops_metadata
method.
boto3 documentation
def update_ops_metadata(
self,
*,
OpsMetadataArn: str,
MetadataToUpdate: Mapping[str, MetadataValueTypeDef] = ..., # (1)
KeysToDelete: Sequence[str] = ...,
) -> UpdateOpsMetadataResultTypeDef: # (2)
...
kwargs: UpdateOpsMetadataRequestRequestTypeDef = { # (1)
"OpsMetadataArn": ...,
}
parent.update_ops_metadata(**kwargs)
update_patch_baseline
Modifies an existing patch baseline.
Type annotations and code completion for boto3.client("ssm").update_patch_baseline
method.
boto3 documentation
def update_patch_baseline(
self,
*,
BaselineId: str,
Name: str = ...,
GlobalFilters: PatchFilterGroupTypeDef = ..., # (1)
ApprovalRules: PatchRuleGroupTypeDef = ..., # (2)
ApprovedPatches: Sequence[str] = ...,
ApprovedPatchesComplianceLevel: PatchComplianceLevelType = ..., # (3)
ApprovedPatchesEnableNonSecurity: bool = ...,
RejectedPatches: Sequence[str] = ...,
RejectedPatchesAction: PatchActionType = ..., # (4)
Description: str = ...,
Sources: Sequence[PatchSourceTypeDef] = ..., # (5)
Replace: bool = ...,
) -> UpdatePatchBaselineResultTypeDef: # (6)
...
- See PatchFilterGroupTypeDef
- See PatchRuleGroupTypeDef
- See PatchComplianceLevelType
- See PatchActionType
- See PatchSourceTypeDef
- See UpdatePatchBaselineResultTypeDef
kwargs: UpdatePatchBaselineRequestRequestTypeDef = { # (1)
"BaselineId": ...,
}
parent.update_patch_baseline(**kwargs)
update_resource_data_sync
Update a resource data sync.
Type annotations and code completion for boto3.client("ssm").update_resource_data_sync
method.
boto3 documentation
def update_resource_data_sync(
self,
*,
SyncName: str,
SyncType: str,
SyncSource: ResourceDataSyncSourceTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateResourceDataSyncRequestRequestTypeDef = { # (1)
"SyncName": ...,
"SyncType": ...,
"SyncSource": ...,
}
parent.update_resource_data_sync(**kwargs)
update_service_setting
ServiceSetting
is an account-level setting for an Amazon Web Services service.
Type annotations and code completion for boto3.client("ssm").update_service_setting
method.
boto3 documentation
def update_service_setting(
self,
*,
SettingId: str,
SettingValue: str,
) -> Dict[str, Any]:
...
kwargs: UpdateServiceSettingRequestRequestTypeDef = { # (1)
"SettingId": ...,
"SettingValue": ...,
}
parent.update_service_setting(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("ssm").get_paginator
method with overloads.
client.get_paginator("describe_activations")
-> DescribeActivationsPaginatorclient.get_paginator("describe_association_execution_targets")
-> DescribeAssociationExecutionTargetsPaginatorclient.get_paginator("describe_association_executions")
-> DescribeAssociationExecutionsPaginatorclient.get_paginator("describe_automation_executions")
-> DescribeAutomationExecutionsPaginatorclient.get_paginator("describe_automation_step_executions")
-> DescribeAutomationStepExecutionsPaginatorclient.get_paginator("describe_available_patches")
-> DescribeAvailablePatchesPaginatorclient.get_paginator("describe_effective_instance_associations")
-> DescribeEffectiveInstanceAssociationsPaginatorclient.get_paginator("describe_effective_patches_for_patch_baseline")
-> DescribeEffectivePatchesForPatchBaselinePaginatorclient.get_paginator("describe_instance_associations_status")
-> DescribeInstanceAssociationsStatusPaginatorclient.get_paginator("describe_instance_information")
-> DescribeInstanceInformationPaginatorclient.get_paginator("describe_instance_patch_states")
-> DescribeInstancePatchStatesPaginatorclient.get_paginator("describe_instance_patch_states_for_patch_group")
-> DescribeInstancePatchStatesForPatchGroupPaginatorclient.get_paginator("describe_instance_patches")
-> DescribeInstancePatchesPaginatorclient.get_paginator("describe_inventory_deletions")
-> DescribeInventoryDeletionsPaginatorclient.get_paginator("describe_maintenance_window_execution_task_invocations")
-> DescribeMaintenanceWindowExecutionTaskInvocationsPaginatorclient.get_paginator("describe_maintenance_window_execution_tasks")
-> DescribeMaintenanceWindowExecutionTasksPaginatorclient.get_paginator("describe_maintenance_window_executions")
-> DescribeMaintenanceWindowExecutionsPaginatorclient.get_paginator("describe_maintenance_window_schedule")
-> DescribeMaintenanceWindowSchedulePaginatorclient.get_paginator("describe_maintenance_window_targets")
-> DescribeMaintenanceWindowTargetsPaginatorclient.get_paginator("describe_maintenance_window_tasks")
-> DescribeMaintenanceWindowTasksPaginatorclient.get_paginator("describe_maintenance_windows")
-> DescribeMaintenanceWindowsPaginatorclient.get_paginator("describe_maintenance_windows_for_target")
-> DescribeMaintenanceWindowsForTargetPaginatorclient.get_paginator("describe_ops_items")
-> DescribeOpsItemsPaginatorclient.get_paginator("describe_parameters")
-> DescribeParametersPaginatorclient.get_paginator("describe_patch_baselines")
-> DescribePatchBaselinesPaginatorclient.get_paginator("describe_patch_groups")
-> DescribePatchGroupsPaginatorclient.get_paginator("describe_patch_properties")
-> DescribePatchPropertiesPaginatorclient.get_paginator("describe_sessions")
-> DescribeSessionsPaginatorclient.get_paginator("get_inventory")
-> GetInventoryPaginatorclient.get_paginator("get_inventory_schema")
-> GetInventorySchemaPaginatorclient.get_paginator("get_ops_summary")
-> GetOpsSummaryPaginatorclient.get_paginator("get_parameter_history")
-> GetParameterHistoryPaginatorclient.get_paginator("get_parameters_by_path")
-> GetParametersByPathPaginatorclient.get_paginator("get_resource_policies")
-> GetResourcePoliciesPaginatorclient.get_paginator("list_association_versions")
-> ListAssociationVersionsPaginatorclient.get_paginator("list_associations")
-> ListAssociationsPaginatorclient.get_paginator("list_command_invocations")
-> ListCommandInvocationsPaginatorclient.get_paginator("list_commands")
-> ListCommandsPaginatorclient.get_paginator("list_compliance_items")
-> ListComplianceItemsPaginatorclient.get_paginator("list_compliance_summaries")
-> ListComplianceSummariesPaginatorclient.get_paginator("list_document_versions")
-> ListDocumentVersionsPaginatorclient.get_paginator("list_documents")
-> ListDocumentsPaginatorclient.get_paginator("list_ops_item_events")
-> ListOpsItemEventsPaginatorclient.get_paginator("list_ops_item_related_items")
-> ListOpsItemRelatedItemsPaginatorclient.get_paginator("list_ops_metadata")
-> ListOpsMetadataPaginatorclient.get_paginator("list_resource_compliance_summaries")
-> ListResourceComplianceSummariesPaginatorclient.get_paginator("list_resource_data_sync")
-> ListResourceDataSyncPaginator
get_waiter
Type annotations and code completion for boto3.client("ssm").get_waiter
method with overloads.
client.get_waiter("command_executed")
-> CommandExecutedWaiter