Skip to content

SSMClient

Index > SSM > 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

Usage example
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.

Usage example
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.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.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)
Type checking example
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

Method definition
def add_tags_to_resource(
    self,
    *,
    ResourceType: ResourceTypeForTaggingType,  # (1)
    ResourceId: str,
    Tags: Sequence[TagTypeDef],  # (2)
) -> Dict[str, Any]:
    ...
  1. See ResourceTypeForTaggingType
  2. See TagTypeDef
Usage example with kwargs
kwargs: AddTagsToResourceRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
    "ResourceId": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceRequestRequestTypeDef

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

Method definition
def associate_ops_item_related_item(
    self,
    *,
    OpsItemId: str,
    AssociationType: str,
    ResourceType: str,
    ResourceUri: str,
) -> AssociateOpsItemRelatedItemResponseTypeDef:  # (1)
    ...
  1. See AssociateOpsItemRelatedItemResponseTypeDef
Usage example with kwargs
kwargs: AssociateOpsItemRelatedItemRequestRequestTypeDef = {  # (1)
    "OpsItemId": ...,
    "AssociationType": ...,
    "ResourceType": ...,
    "ResourceUri": ...,
}

parent.associate_ops_item_related_item(**kwargs)
  1. See AssociateOpsItemRelatedItemRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("ssm").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

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

Method definition
def cancel_command(
    self,
    *,
    CommandId: str,
    InstanceIds: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CancelCommandRequestRequestTypeDef = {  # (1)
    "CommandId": ...,
}

parent.cancel_command(**kwargs)
  1. See CancelCommandRequestRequestTypeDef

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

Method definition
def cancel_maintenance_window_execution(
    self,
    *,
    WindowExecutionId: str,
) -> CancelMaintenanceWindowExecutionResultTypeDef:  # (1)
    ...
  1. See CancelMaintenanceWindowExecutionResultTypeDef
Usage example with kwargs
kwargs: CancelMaintenanceWindowExecutionRequestRequestTypeDef = {  # (1)
    "WindowExecutionId": ...,
}

parent.cancel_maintenance_window_execution(**kwargs)
  1. See CancelMaintenanceWindowExecutionRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("ssm").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

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

Method definition
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)
    ...
  1. See TagTypeDef
  2. See RegistrationMetadataItemTypeDef
  3. See CreateActivationResultTypeDef
Usage example with kwargs
kwargs: CreateActivationRequestRequestTypeDef = {  # (1)
    "IamRole": ...,
}

parent.create_activation(**kwargs)
  1. See CreateActivationRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See TargetTypeDef
  2. See InstanceAssociationOutputLocationTypeDef
  3. See AssociationComplianceSeverityType
  4. See AssociationSyncComplianceType
  5. See TargetLocationTypeDef
  6. See TagTypeDef
  7. See AlarmConfigurationTypeDef
  8. See CreateAssociationResultTypeDef
Usage example with kwargs
kwargs: CreateAssociationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_association(**kwargs)
  1. See CreateAssociationRequestRequestTypeDef

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

Method definition
def create_association_batch(
    self,
    *,
    Entries: Sequence[CreateAssociationBatchRequestEntryTypeDef],  # (1)
) -> CreateAssociationBatchResultTypeDef:  # (2)
    ...
  1. See CreateAssociationBatchRequestEntryTypeDef
  2. See CreateAssociationBatchResultTypeDef
Usage example with kwargs
kwargs: CreateAssociationBatchRequestRequestTypeDef = {  # (1)
    "Entries": ...,
}

parent.create_association_batch(**kwargs)
  1. See CreateAssociationBatchRequestRequestTypeDef

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

Method definition
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)
    ...
  1. See DocumentRequiresTypeDef
  2. See AttachmentsSourceTypeDef
  3. See DocumentTypeType
  4. See DocumentFormatType
  5. See TagTypeDef
  6. See CreateDocumentResultTypeDef
Usage example with kwargs
kwargs: CreateDocumentRequestRequestTypeDef = {  # (1)
    "Content": ...,
    "Name": ...,
}

parent.create_document(**kwargs)
  1. See CreateDocumentRequestRequestTypeDef

create_maintenance_window

Creates a new maintenance window.

Type annotations and code completion for boto3.client("ssm").create_maintenance_window method. boto3 documentation

Method definition
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)
    ...
  1. See TagTypeDef
  2. See CreateMaintenanceWindowResultTypeDef
Usage example with kwargs
kwargs: CreateMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Schedule": ...,
    "Duration": ...,
    "Cutoff": ...,
    "AllowUnassociatedTargets": ...,
}

parent.create_maintenance_window(**kwargs)
  1. See CreateMaintenanceWindowRequestRequestTypeDef

create_ops_item

Creates a new OpsItem.

Type annotations and code completion for boto3.client("ssm").create_ops_item method. boto3 documentation

Method definition
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] = ...,
) -> CreateOpsItemResponseTypeDef:  # (5)
    ...
  1. See OpsItemDataValueTypeDef
  2. See OpsItemNotificationTypeDef
  3. See RelatedOpsItemTypeDef
  4. See TagTypeDef
  5. See CreateOpsItemResponseTypeDef
Usage example with kwargs
kwargs: CreateOpsItemRequestRequestTypeDef = {  # (1)
    "Description": ...,
    "Source": ...,
    "Title": ...,
}

parent.create_ops_item(**kwargs)
  1. See CreateOpsItemRequestRequestTypeDef

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

Method definition
def create_ops_metadata(
    self,
    *,
    ResourceId: str,
    Metadata: Mapping[str, MetadataValueTypeDef] = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateOpsMetadataResultTypeDef:  # (3)
    ...
  1. See MetadataValueTypeDef
  2. See TagTypeDef
  3. See CreateOpsMetadataResultTypeDef
Usage example with kwargs
kwargs: CreateOpsMetadataRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.create_ops_metadata(**kwargs)
  1. See CreateOpsMetadataRequestRequestTypeDef

create_patch_baseline

Creates a patch baseline.

Type annotations and code completion for boto3.client("ssm").create_patch_baseline method. boto3 documentation

Method definition
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)
    ...
  1. See OperatingSystemType
  2. See PatchFilterGroupTypeDef
  3. See PatchRuleGroupTypeDef
  4. See PatchComplianceLevelType
  5. See PatchActionType
  6. See PatchSourceTypeDef
  7. See TagTypeDef
  8. See CreatePatchBaselineResultTypeDef
Usage example with kwargs
kwargs: CreatePatchBaselineRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_patch_baseline(**kwargs)
  1. See CreatePatchBaselineRequestRequestTypeDef

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

Method definition
def create_resource_data_sync(
    self,
    *,
    SyncName: str,
    S3Destination: ResourceDataSyncS3DestinationTypeDef = ...,  # (1)
    SyncType: str = ...,
    SyncSource: ResourceDataSyncSourceTypeDef = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See ResourceDataSyncS3DestinationTypeDef
  2. See ResourceDataSyncSourceTypeDef
Usage example with kwargs
kwargs: CreateResourceDataSyncRequestRequestTypeDef = {  # (1)
    "SyncName": ...,
}

parent.create_resource_data_sync(**kwargs)
  1. See CreateResourceDataSyncRequestRequestTypeDef

delete_activation

Deletes an activation.

Type annotations and code completion for boto3.client("ssm").delete_activation method. boto3 documentation

Method definition
def delete_activation(
    self,
    *,
    ActivationId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteActivationRequestRequestTypeDef = {  # (1)
    "ActivationId": ...,
}

parent.delete_activation(**kwargs)
  1. See DeleteActivationRequestRequestTypeDef

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

Method definition
def delete_association(
    self,
    *,
    Name: str = ...,
    InstanceId: str = ...,
    AssociationId: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAssociationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_association(**kwargs)
  1. See DeleteAssociationRequestRequestTypeDef

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

Method definition
def delete_document(
    self,
    *,
    Name: str,
    DocumentVersion: str = ...,
    VersionName: str = ...,
    Force: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteDocumentRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_document(**kwargs)
  1. See DeleteDocumentRequestRequestTypeDef

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

Method definition
def delete_inventory(
    self,
    *,
    TypeName: str,
    SchemaDeleteOption: InventorySchemaDeleteOptionType = ...,  # (1)
    DryRun: bool = ...,
    ClientToken: str = ...,
) -> DeleteInventoryResultTypeDef:  # (2)
    ...
  1. See InventorySchemaDeleteOptionType
  2. See DeleteInventoryResultTypeDef
Usage example with kwargs
kwargs: DeleteInventoryRequestRequestTypeDef = {  # (1)
    "TypeName": ...,
}

parent.delete_inventory(**kwargs)
  1. See DeleteInventoryRequestRequestTypeDef

delete_maintenance_window

Deletes a maintenance window.

Type annotations and code completion for boto3.client("ssm").delete_maintenance_window method. boto3 documentation

Method definition
def delete_maintenance_window(
    self,
    *,
    WindowId: str,
) -> DeleteMaintenanceWindowResultTypeDef:  # (1)
    ...
  1. See DeleteMaintenanceWindowResultTypeDef
Usage example with kwargs
kwargs: DeleteMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.delete_maintenance_window(**kwargs)
  1. See DeleteMaintenanceWindowRequestRequestTypeDef

delete_ops_metadata

Delete OpsMetadata related to an application.

Type annotations and code completion for boto3.client("ssm").delete_ops_metadata method. boto3 documentation

Method definition
def delete_ops_metadata(
    self,
    *,
    OpsMetadataArn: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteOpsMetadataRequestRequestTypeDef = {  # (1)
    "OpsMetadataArn": ...,
}

parent.delete_ops_metadata(**kwargs)
  1. See DeleteOpsMetadataRequestRequestTypeDef

delete_parameter

Delete a parameter from the system.

Type annotations and code completion for boto3.client("ssm").delete_parameter method. boto3 documentation

Method definition
def delete_parameter(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteParameterRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_parameter(**kwargs)
  1. See DeleteParameterRequestRequestTypeDef

delete_parameters

Delete a list of parameters.

Type annotations and code completion for boto3.client("ssm").delete_parameters method. boto3 documentation

Method definition
def delete_parameters(
    self,
    *,
    Names: Sequence[str],
) -> DeleteParametersResultTypeDef:  # (1)
    ...
  1. See DeleteParametersResultTypeDef
Usage example with kwargs
kwargs: DeleteParametersRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.delete_parameters(**kwargs)
  1. See DeleteParametersRequestRequestTypeDef

delete_patch_baseline

Deletes a patch baseline.

Type annotations and code completion for boto3.client("ssm").delete_patch_baseline method. boto3 documentation

Method definition
def delete_patch_baseline(
    self,
    *,
    BaselineId: str,
) -> DeletePatchBaselineResultTypeDef:  # (1)
    ...
  1. See DeletePatchBaselineResultTypeDef
Usage example with kwargs
kwargs: DeletePatchBaselineRequestRequestTypeDef = {  # (1)
    "BaselineId": ...,
}

parent.delete_patch_baseline(**kwargs)
  1. See DeletePatchBaselineRequestRequestTypeDef

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

Method definition
def delete_resource_data_sync(
    self,
    *,
    SyncName: str,
    SyncType: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteResourceDataSyncRequestRequestTypeDef = {  # (1)
    "SyncName": ...,
}

parent.delete_resource_data_sync(**kwargs)
  1. See DeleteResourceDataSyncRequestRequestTypeDef

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

Method definition
def deregister_managed_instance(
    self,
    *,
    InstanceId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeregisterManagedInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.deregister_managed_instance(**kwargs)
  1. See DeregisterManagedInstanceRequestRequestTypeDef

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

Method definition
def deregister_patch_baseline_for_patch_group(
    self,
    *,
    BaselineId: str,
    PatchGroup: str,
) -> DeregisterPatchBaselineForPatchGroupResultTypeDef:  # (1)
    ...
  1. See DeregisterPatchBaselineForPatchGroupResultTypeDef
Usage example with kwargs
kwargs: DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef = {  # (1)
    "BaselineId": ...,
    "PatchGroup": ...,
}

parent.deregister_patch_baseline_for_patch_group(**kwargs)
  1. See DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef

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

Method definition
def deregister_target_from_maintenance_window(
    self,
    *,
    WindowId: str,
    WindowTargetId: str,
    Safe: bool = ...,
) -> DeregisterTargetFromMaintenanceWindowResultTypeDef:  # (1)
    ...
  1. See DeregisterTargetFromMaintenanceWindowResultTypeDef
Usage example with kwargs
kwargs: DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
    "WindowTargetId": ...,
}

parent.deregister_target_from_maintenance_window(**kwargs)
  1. See DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef

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

Method definition
def deregister_task_from_maintenance_window(
    self,
    *,
    WindowId: str,
    WindowTaskId: str,
) -> DeregisterTaskFromMaintenanceWindowResultTypeDef:  # (1)
    ...
  1. See DeregisterTaskFromMaintenanceWindowResultTypeDef
Usage example with kwargs
kwargs: DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
    "WindowTaskId": ...,
}

parent.deregister_task_from_maintenance_window(**kwargs)
  1. See DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef

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

Method definition
def describe_activations(
    self,
    *,
    Filters: Sequence[DescribeActivationsFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeActivationsResultTypeDef:  # (2)
    ...
  1. See DescribeActivationsFilterTypeDef
  2. See DescribeActivationsResultTypeDef
Usage example with kwargs
kwargs: DescribeActivationsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_activations(**kwargs)
  1. See DescribeActivationsRequestRequestTypeDef

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

Method definition
def describe_association(
    self,
    *,
    Name: str = ...,
    InstanceId: str = ...,
    AssociationId: str = ...,
    AssociationVersion: str = ...,
) -> DescribeAssociationResultTypeDef:  # (1)
    ...
  1. See DescribeAssociationResultTypeDef
Usage example with kwargs
kwargs: DescribeAssociationRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_association(**kwargs)
  1. See DescribeAssociationRequestRequestTypeDef

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

Method definition
def describe_association_execution_targets(
    self,
    *,
    AssociationId: str,
    ExecutionId: str,
    Filters: Sequence[AssociationExecutionTargetsFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAssociationExecutionTargetsResultTypeDef:  # (2)
    ...
  1. See AssociationExecutionTargetsFilterTypeDef
  2. See DescribeAssociationExecutionTargetsResultTypeDef
Usage example with kwargs
kwargs: DescribeAssociationExecutionTargetsRequestRequestTypeDef = {  # (1)
    "AssociationId": ...,
    "ExecutionId": ...,
}

parent.describe_association_execution_targets(**kwargs)
  1. See DescribeAssociationExecutionTargetsRequestRequestTypeDef

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

Method definition
def describe_association_executions(
    self,
    *,
    AssociationId: str,
    Filters: Sequence[AssociationExecutionFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAssociationExecutionsResultTypeDef:  # (2)
    ...
  1. See AssociationExecutionFilterTypeDef
  2. See DescribeAssociationExecutionsResultTypeDef
Usage example with kwargs
kwargs: DescribeAssociationExecutionsRequestRequestTypeDef = {  # (1)
    "AssociationId": ...,
}

parent.describe_association_executions(**kwargs)
  1. See DescribeAssociationExecutionsRequestRequestTypeDef

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

Method definition
def describe_automation_executions(
    self,
    *,
    Filters: Sequence[AutomationExecutionFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAutomationExecutionsResultTypeDef:  # (2)
    ...
  1. See AutomationExecutionFilterTypeDef
  2. See DescribeAutomationExecutionsResultTypeDef
Usage example with kwargs
kwargs: DescribeAutomationExecutionsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_automation_executions(**kwargs)
  1. See DescribeAutomationExecutionsRequestRequestTypeDef

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

Method definition
def describe_automation_step_executions(
    self,
    *,
    AutomationExecutionId: str,
    Filters: Sequence[StepExecutionFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ReverseOrder: bool = ...,
) -> DescribeAutomationStepExecutionsResultTypeDef:  # (2)
    ...
  1. See StepExecutionFilterTypeDef
  2. See DescribeAutomationStepExecutionsResultTypeDef
Usage example with kwargs
kwargs: DescribeAutomationStepExecutionsRequestRequestTypeDef = {  # (1)
    "AutomationExecutionId": ...,
}

parent.describe_automation_step_executions(**kwargs)
  1. See DescribeAutomationStepExecutionsRequestRequestTypeDef

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

Method definition
def describe_available_patches(
    self,
    *,
    Filters: Sequence[PatchOrchestratorFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAvailablePatchesResultTypeDef:  # (2)
    ...
  1. See PatchOrchestratorFilterTypeDef
  2. See DescribeAvailablePatchesResultTypeDef
Usage example with kwargs
kwargs: DescribeAvailablePatchesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_available_patches(**kwargs)
  1. See DescribeAvailablePatchesRequestRequestTypeDef

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

Method definition
def describe_document(
    self,
    *,
    Name: str,
    DocumentVersion: str = ...,
    VersionName: str = ...,
) -> DescribeDocumentResultTypeDef:  # (1)
    ...
  1. See DescribeDocumentResultTypeDef
Usage example with kwargs
kwargs: DescribeDocumentRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_document(**kwargs)
  1. See DescribeDocumentRequestRequestTypeDef

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

Method definition
def describe_document_permission(
    self,
    *,
    Name: str,
    PermissionType: DocumentPermissionTypeType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDocumentPermissionResponseTypeDef:  # (2)
    ...
  1. See DocumentPermissionTypeType
  2. See DescribeDocumentPermissionResponseTypeDef
Usage example with kwargs
kwargs: DescribeDocumentPermissionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "PermissionType": ...,
}

parent.describe_document_permission(**kwargs)
  1. See DescribeDocumentPermissionRequestRequestTypeDef

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

Method definition
def describe_effective_instance_associations(
    self,
    *,
    InstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeEffectiveInstanceAssociationsResultTypeDef:  # (1)
    ...
  1. See DescribeEffectiveInstanceAssociationsResultTypeDef
Usage example with kwargs
kwargs: DescribeEffectiveInstanceAssociationsRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_effective_instance_associations(**kwargs)
  1. See DescribeEffectiveInstanceAssociationsRequestRequestTypeDef

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

Method definition
def describe_effective_patches_for_patch_baseline(
    self,
    *,
    BaselineId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeEffectivePatchesForPatchBaselineResultTypeDef:  # (1)
    ...
  1. See DescribeEffectivePatchesForPatchBaselineResultTypeDef
Usage example with kwargs
kwargs: DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef = {  # (1)
    "BaselineId": ...,
}

parent.describe_effective_patches_for_patch_baseline(**kwargs)
  1. See DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef

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

Method definition
def describe_instance_associations_status(
    self,
    *,
    InstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeInstanceAssociationsStatusResultTypeDef:  # (1)
    ...
  1. See DescribeInstanceAssociationsStatusResultTypeDef
Usage example with kwargs
kwargs: DescribeInstanceAssociationsStatusRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_instance_associations_status(**kwargs)
  1. See DescribeInstanceAssociationsStatusRequestRequestTypeDef

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

Method definition
def describe_instance_information(
    self,
    *,
    InstanceInformationFilterList: Sequence[InstanceInformationFilterTypeDef] = ...,  # (1)
    Filters: Sequence[InstanceInformationStringFilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeInstanceInformationResultTypeDef:  # (3)
    ...
  1. See InstanceInformationFilterTypeDef
  2. See InstanceInformationStringFilterTypeDef
  3. See DescribeInstanceInformationResultTypeDef
Usage example with kwargs
kwargs: DescribeInstanceInformationRequestRequestTypeDef = {  # (1)
    "InstanceInformationFilterList": ...,
}

parent.describe_instance_information(**kwargs)
  1. See DescribeInstanceInformationRequestRequestTypeDef

describe_instance_patch_states

.

Type annotations and code completion for boto3.client("ssm").describe_instance_patch_states method. boto3 documentation

Method definition
def describe_instance_patch_states(
    self,
    *,
    InstanceIds: Sequence[str],
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeInstancePatchStatesResultTypeDef:  # (1)
    ...
  1. See DescribeInstancePatchStatesResultTypeDef
Usage example with kwargs
kwargs: DescribeInstancePatchStatesRequestRequestTypeDef = {  # (1)
    "InstanceIds": ...,
}

parent.describe_instance_patch_states(**kwargs)
  1. See DescribeInstancePatchStatesRequestRequestTypeDef<