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

# SSMClient 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.

# Exceptions.exceptions usage example

client = boto3.client("ssm")

try:
    do_something(client)
except (
    client.exceptions.AlreadyExistsException,
    client.exceptions.AssociatedInstances,
    client.exceptions.AssociationAlreadyExists,
    client.exceptions.AssociationDoesNotExist,
    client.exceptions.AssociationExecutionDoesNotExist,
    client.exceptions.AssociationLimitExceeded,
    client.exceptions.AssociationVersionLimitExceeded,
    client.exceptions.AutomationDefinitionNotApprovedException,
    client.exceptions.AutomationDefinitionNotFoundException,
    client.exceptions.AutomationDefinitionVersionNotFoundException,
    client.exceptions.AutomationExecutionLimitExceededException,
    client.exceptions.AutomationExecutionNotFoundException,
    client.exceptions.AutomationStepNotFoundException,
    client.exceptions.ClientError,
    client.exceptions.ComplianceTypeCountLimitExceededException,
    client.exceptions.CustomSchemaCountLimitExceededException,
    client.exceptions.DocumentAlreadyExists,
    client.exceptions.DocumentLimitExceeded,
    client.exceptions.DocumentPermissionLimit,
    client.exceptions.DocumentVersionLimitExceeded,
    client.exceptions.DoesNotExistException,
    client.exceptions.DuplicateDocumentContent,
    client.exceptions.DuplicateDocumentVersionName,
    client.exceptions.DuplicateInstanceId,
    client.exceptions.FeatureNotAvailableException,
    client.exceptions.HierarchyLevelLimitExceededException,
    client.exceptions.HierarchyTypeMismatchException,
    client.exceptions.IdempotentParameterMismatch,
    client.exceptions.IncompatiblePolicyException,
    client.exceptions.InternalServerError,
    client.exceptions.InvalidActivation,
    client.exceptions.InvalidActivationId,
    client.exceptions.InvalidAggregatorException,
    client.exceptions.InvalidAllowedPatternException,
    client.exceptions.InvalidAssociation,
    client.exceptions.InvalidAssociationVersion,
    client.exceptions.InvalidAutomationExecutionParametersException,
    client.exceptions.InvalidAutomationSignalException,
    client.exceptions.InvalidAutomationStatusUpdateException,
    client.exceptions.InvalidCommandId,
    client.exceptions.InvalidDeleteInventoryParametersException,
    client.exceptions.InvalidDeletionIdException,
    client.exceptions.InvalidDocument,
    client.exceptions.InvalidDocumentContent,
    client.exceptions.InvalidDocumentOperation,
    client.exceptions.InvalidDocumentSchemaVersion,
    client.exceptions.InvalidDocumentType,
    client.exceptions.InvalidDocumentVersion,
    client.exceptions.InvalidFilter,
    client.exceptions.InvalidFilterKey,
    client.exceptions.InvalidFilterOption,
    client.exceptions.InvalidFilterValue,
    client.exceptions.InvalidInstanceId,
    client.exceptions.InvalidInstanceInformationFilterValue,
    client.exceptions.InvalidInstancePropertyFilterValue,
    client.exceptions.InvalidInventoryGroupException,
    client.exceptions.InvalidInventoryItemContextException,
    client.exceptions.InvalidInventoryRequestException,
    client.exceptions.InvalidItemContentException,
    client.exceptions.InvalidKeyId,
    client.exceptions.InvalidNextToken,
    client.exceptions.InvalidNotificationConfig,
    client.exceptions.InvalidOptionException,
    client.exceptions.InvalidOutputFolder,
    client.exceptions.InvalidOutputLocation,
    client.exceptions.InvalidParameters,
    client.exceptions.InvalidPermissionType,
    client.exceptions.InvalidPluginName,
    client.exceptions.InvalidPolicyAttributeException,
    client.exceptions.InvalidPolicyTypeException,
    client.exceptions.InvalidResourceId,
    client.exceptions.InvalidResourceType,
    client.exceptions.InvalidResultAttributeException,
    client.exceptions.InvalidRole,
    client.exceptions.InvalidSchedule,
    client.exceptions.InvalidTag,
    client.exceptions.InvalidTarget,
    client.exceptions.InvalidTargetMaps,
    client.exceptions.InvalidTypeNameException,
    client.exceptions.InvalidUpdate,
    client.exceptions.InvocationDoesNotExist,
    client.exceptions.ItemContentMismatchException,
    client.exceptions.ItemSizeLimitExceededException,
    client.exceptions.MalformedResourcePolicyDocumentException,
    client.exceptions.MaxDocumentSizeExceeded,
    client.exceptions.OpsItemAccessDeniedException,
    client.exceptions.OpsItemAlreadyExistsException,
    client.exceptions.OpsItemConflictException,
    client.exceptions.OpsItemInvalidParameterException,
    client.exceptions.OpsItemLimitExceededException,
    client.exceptions.OpsItemNotFoundException,
    client.exceptions.OpsItemRelatedItemAlreadyExistsException,
    client.exceptions.OpsItemRelatedItemAssociationNotFoundException,
    client.exceptions.OpsMetadataAlreadyExistsException,
    client.exceptions.OpsMetadataInvalidArgumentException,
    client.exceptions.OpsMetadataKeyLimitExceededException,
    client.exceptions.OpsMetadataLimitExceededException,
    client.exceptions.OpsMetadataNotFoundException,
    client.exceptions.OpsMetadataTooManyUpdatesException,
    client.exceptions.ParameterAlreadyExists,
    client.exceptions.ParameterLimitExceeded,
    client.exceptions.ParameterMaxVersionLimitExceeded,
    client.exceptions.ParameterNotFound,
    client.exceptions.ParameterPatternMismatchException,
    client.exceptions.ParameterVersionLabelLimitExceeded,
    client.exceptions.ParameterVersionNotFound,
    client.exceptions.PoliciesLimitExceededException,
    client.exceptions.ResourceDataSyncAlreadyExistsException,
    client.exceptions.ResourceDataSyncConflictException,
    client.exceptions.ResourceDataSyncCountExceededException,
    client.exceptions.ResourceDataSyncInvalidConfigurationException,
    client.exceptions.ResourceDataSyncNotFoundException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourcePolicyConflictException,
    client.exceptions.ResourcePolicyInvalidParameterException,
    client.exceptions.ResourcePolicyLimitExceededException,
    client.exceptions.ResourcePolicyNotFoundException,
    client.exceptions.ServiceSettingNotFound,
    client.exceptions.StatusUnchanged,
    client.exceptions.SubTypeCountLimitExceededException,
    client.exceptions.TargetInUseException,
    client.exceptions.TargetNotConnected,
    client.exceptions.TooManyTagsError,
    client.exceptions.TooManyUpdates,
    client.exceptions.TotalSizeLimitExceededException,
    client.exceptions.UnsupportedCalendarException,
    client.exceptions.UnsupportedFeatureRequiredException,
    client.exceptions.UnsupportedInventoryItemContextException,
    client.exceptions.UnsupportedInventorySchemaVersionException,
    client.exceptions.UnsupportedOperatingSystem,
    client.exceptions.UnsupportedOperationException,
    client.exceptions.UnsupportedParameterType,
    client.exceptions.UnsupportedPlatformType,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_ssm.client import Exceptions

def handle_error(exc: Exceptions.AlreadyExistsException) -> None:
    ...

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

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

# add_tags_to_resource 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

# add_tags_to_resource method usage example with argument unpacking

kwargs: AddTagsToResourceRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
    "ResourceId": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)

1. See AddTagsToResourceRequestRequestTypeDef

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

# associate_ops_item_related_item method definition

def associate_ops_item_related_item(
    self,
    *,
    OpsItemId: str,
    AssociationType: str,
    ResourceType: str,
    ResourceUri: str,
) -> AssociateOpsItemRelatedItemResponseTypeDef:  # (1)
    ...

1. See AssociateOpsItemRelatedItemResponseTypeDef

# associate_ops_item_related_item method usage example with argument unpacking

kwargs: AssociateOpsItemRelatedItemRequestRequestTypeDef = {  # (1)
    "OpsItemId": ...,
    "AssociationType": ...,
    "ResourceType": ...,
    "ResourceUri": ...,
}

parent.associate_ops_item_related_item(**kwargs)

1. See AssociateOpsItemRelatedItemRequestRequestTypeDef

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

# cancel_command method definition

def cancel_command(
    self,
    *,
    CommandId: str,
    InstanceIds: Sequence[str] = ...,
) -> dict[str, Any]:
    ...

# cancel_command method usage example with argument unpacking

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

# cancel_maintenance_window_execution method definition

def cancel_maintenance_window_execution(
    self,
    *,
    WindowExecutionId: str,
) -> CancelMaintenanceWindowExecutionResultTypeDef:  # (1)
    ...

1. See CancelMaintenanceWindowExecutionResultTypeDef

# cancel_maintenance_window_execution method usage example with argument unpacking

kwargs: CancelMaintenanceWindowExecutionRequestRequestTypeDef = {  # (1)
    "WindowExecutionId": ...,
}

parent.cancel_maintenance_window_execution(**kwargs)

1. See CancelMaintenanceWindowExecutionRequestRequestTypeDef

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

# create_activation method definition

def create_activation(
    self,
    *,
    IamRole: str,
    Description: str = ...,
    DefaultInstanceName: str = ...,
    RegistrationLimit: int = ...,
    ExpirationDate: TimestampTypeDef = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    RegistrationMetadata: Sequence[RegistrationMetadataItemTypeDef] = ...,  # (2)
) -> CreateActivationResultTypeDef:  # (3)
    ...

1. See TagTypeDef
2. See RegistrationMetadataItemTypeDef
3. See CreateActivationResultTypeDef

# create_activation method usage example with argument unpacking

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

# create_association method definition

def create_association(
    self,
    *,
    Name: str,
    DocumentVersion: str = ...,
    InstanceId: str = ...,
    Parameters: Mapping[str, Sequence[str]] = ...,
    Targets: Sequence[TargetUnionTypeDef] = ...,  # (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[TargetLocationUnionTypeDef] = ...,  # (5)
    ScheduleOffset: int = ...,
    Duration: int = ...,
    TargetMaps: Sequence[Mapping[str, Sequence[str]]] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (6)
    AlarmConfiguration: AlarmConfigurationTypeDef = ...,  # (7)
) -> CreateAssociationResultTypeDef:  # (8)
    ...

1. See TargetTypeDef TargetOutputTypeDef
2. See InstanceAssociationOutputLocationTypeDef
3. See AssociationComplianceSeverityType
4. See AssociationSyncComplianceType
5. See TargetLocationTypeDef TargetLocationOutputTypeDef
6. See TagTypeDef
7. See AlarmConfigurationTypeDef
8. See CreateAssociationResultTypeDef

# create_association method usage example with argument unpacking

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

# create_association_batch method definition

def create_association_batch(
    self,
    *,
    Entries: Sequence[CreateAssociationBatchRequestEntryUnionTypeDef],  # (1)
) -> CreateAssociationBatchResultTypeDef:  # (2)
    ...

1. See CreateAssociationBatchRequestEntryTypeDef CreateAssociationBatchRequestEntryOutputTypeDef
2. See CreateAssociationBatchResultTypeDef

# create_association_batch method usage example with argument unpacking

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

# create_document 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

# create_document method usage example with argument unpacking

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

# create_maintenance_window 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

# create_maintenance_window method usage example with argument unpacking

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

# create_ops_item 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: TimestampTypeDef = ...,
    ActualEndTime: TimestampTypeDef = ...,
    PlannedStartTime: TimestampTypeDef = ...,
    PlannedEndTime: TimestampTypeDef = ...,
    AccountId: str = ...,
) -> CreateOpsItemResponseTypeDef:  # (5)
    ...

1. See OpsItemDataValueTypeDef
2. See OpsItemNotificationTypeDef
3. See RelatedOpsItemTypeDef
4. See TagTypeDef
5. See CreateOpsItemResponseTypeDef

# create_ops_item method usage example with argument unpacking

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

# create_ops_metadata 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

# create_ops_metadata method usage example with argument unpacking

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

# create_patch_baseline 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[PatchSourceUnionTypeDef] = ...,  # (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 PatchSourceOutputTypeDef
7. See TagTypeDef
8. See CreatePatchBaselineResultTypeDef

# create_patch_baseline method usage example with argument unpacking

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

# create_resource_data_sync 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

# create_resource_data_sync method usage example with argument unpacking

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

# delete_activation method definition

def delete_activation(
    self,
    *,
    ActivationId: str,
) -> dict[str, Any]:
    ...

# delete_activation method usage example with argument unpacking

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

# delete_association method definition

def delete_association(
    self,
    *,
    Name: str = ...,
    InstanceId: str = ...,
    AssociationId: str = ...,
) -> dict[str, Any]:
    ...

# delete_association method usage example with argument unpacking

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

# delete_document method definition

def delete_document(
    self,
    *,
    Name: str,
    DocumentVersion: str = ...,
    VersionName: str = ...,
    Force: bool = ...,
) -> dict[str, Any]:
    ...

# delete_document method usage example with argument unpacking

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

# delete_inventory method definition

def delete_inventory(
    self,
    *,
    TypeName: str,
    SchemaDeleteOption: InventorySchemaDeleteOptionType = ...,  # (1)
    DryRun: bool = ...,
    ClientToken: str = ...,
) -> DeleteInventoryResultTypeDef:  # (2)
    ...

1. See InventorySchemaDeleteOptionType
2. See DeleteInventoryResultTypeDef

# delete_inventory method usage example with argument unpacking

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

# delete_maintenance_window method definition

def delete_maintenance_window(
    self,
    *,
    WindowId: str,
) -> DeleteMaintenanceWindowResultTypeDef:  # (1)
    ...

1. See DeleteMaintenanceWindowResultTypeDef

# delete_maintenance_window method usage example with argument unpacking

kwargs: DeleteMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.delete_maintenance_window(**kwargs)

1. See DeleteMaintenanceWindowRequestRequestTypeDef

delete_ops_item

Delete an OpsItem.

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

# delete_ops_item method definition

def delete_ops_item(
    self,
    *,
    OpsItemId: str,
) -> dict[str, Any]:
    ...

# delete_ops_item method usage example with argument unpacking

kwargs: DeleteOpsItemRequestRequestTypeDef = {  # (1)
    "OpsItemId": ...,
}

parent.delete_ops_item(**kwargs)

1. See DeleteOpsItemRequestRequestTypeDef

delete_ops_metadata

Delete OpsMetadata related to an application.

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

# delete_ops_metadata method definition

def delete_ops_metadata(
    self,
    *,
    OpsMetadataArn: str,
) -> dict[str, Any]:
    ...

# delete_ops_metadata method usage example with argument unpacking

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

# delete_parameter method definition

def delete_parameter(
    self,
    *,
    Name: str,
) -> dict[str, Any]:
    ...

# delete_parameter method usage example with argument unpacking

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

# delete_parameters method definition

def delete_parameters(
    self,
    *,
    Names: Sequence[str],
) -> DeleteParametersResultTypeDef:  # (1)
    ...

1. See DeleteParametersResultTypeDef

# delete_parameters method usage example with argument unpacking

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

# delete_patch_baseline method definition

def delete_patch_baseline(
    self,
    *,
    BaselineId: str,
) -> DeletePatchBaselineResultTypeDef:  # (1)
    ...

1. See DeletePatchBaselineResultTypeDef

# delete_patch_baseline method usage example with argument unpacking

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

# delete_resource_data_sync method definition

def delete_resource_data_sync(
    self,
    *,
    SyncName: str,
    SyncType: str = ...,
) -> dict[str, Any]:
    ...

# delete_resource_data_sync method usage example with argument unpacking

kwargs: DeleteResourceDataSyncRequestRequestTypeDef = {  # (1)
    "SyncName": ...,
}

parent.delete_resource_data_sync(**kwargs)

1. See DeleteResourceDataSyncRequestRequestTypeDef

delete_resource_policy

Deletes a Systems Manager resource policy.

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

# delete_resource_policy method definition

def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
    PolicyId: str,
    PolicyHash: str,
) -> dict[str, Any]:
    ...

# delete_resource_policy method usage example with argument unpacking

kwargs: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "PolicyId": ...,
    "PolicyHash": ...,
}

parent.delete_resource_policy(**kwargs)

1. See DeleteResourcePolicyRequestRequestTypeDef

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

# deregister_managed_instance method definition

def deregister_managed_instance(
    self,
    *,
    InstanceId: str,
) -> dict[str, Any]:
    ...

# deregister_managed_instance method usage example with argument unpacking

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

# deregister_patch_baseline_for_patch_group method definition

def deregister_patch_baseline_for_patch_group(
    self,
    *,
    BaselineId: str,
    PatchGroup: str,
) -> DeregisterPatchBaselineForPatchGroupResultTypeDef:  # (1)
    ...

1. See DeregisterPatchBaselineForPatchGroupResultTypeDef

# deregister_patch_baseline_for_patch_group method usage example with argument unpacking

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

# deregister_target_from_maintenance_window method definition

def deregister_target_from_maintenance_window(
    self,
    *,
    WindowId: str,
    WindowTargetId: str,
    Safe: bool = ...,
) -> DeregisterTargetFromMaintenanceWindowResultTypeDef:  # (1)
    ...

1. See DeregisterTargetFromMaintenanceWindowResultTypeDef

# deregister_target_from_maintenance_window method usage example with argument unpacking

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

# deregister_task_from_maintenance_window method definition

def deregister_task_from_maintenance_window(
    self,
    *,
    WindowId: str,
    WindowTaskId: str,
) -> DeregisterTaskFromMaintenanceWindowResultTypeDef:  # (1)
    ...

1. See DeregisterTaskFromMaintenanceWindowResultTypeDef

# deregister_task_from_maintenance_window method usage example with argument unpacking

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

# describe_activations method definition

def describe_activations(
    self,
    *,
    Filters: Sequence[DescribeActivationsFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeActivationsResultTypeDef:  # (2)
    ...

1. See DescribeActivationsFilterTypeDef
2. See DescribeActivationsResultTypeDef

# describe_activations method usage example with argument unpacking

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

# describe_association method definition

def describe_association(
    self,
    *,
    Name: str = ...,
    InstanceId: str = ...,
    AssociationId: str = ...,
    AssociationVersion: str = ...,
) -> DescribeAssociationResultTypeDef:  # (1)
    ...

1. See DescribeAssociationResultTypeDef

# describe_association method usage example with argument unpacking

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

# describe_association_execution_targets 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

# describe_association_execution_targets method usage example with argument unpacking

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

# describe_association_executions 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

# describe_association_executions method usage example with argument unpacking

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

# describe_automation_executions method definition

def describe_automation_executions(
    self,
    *,
    Filters: Sequence[AutomationExecutionFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAutomationExecutionsResultTypeDef:  # (2)
    ...

1. See AutomationExecutionFilterTypeDef
2. See DescribeAutomationExecutionsResultTypeDef

# describe_automation_executions method usage example with argument unpacking

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

# describe_automation_step_executions 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

# describe_automation_step_executions method usage example with argument unpacking

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

# describe_available_patches method definition

def describe_available_patches(
    self,
    *,
    Filters: Sequence[PatchOrchestratorFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeAvailablePatchesResultTypeDef:  # (2)
    ...

1. See PatchOrchestratorFilterTypeDef
2. See DescribeAvailablePatchesResultTypeDef

# describe_available_patches method usage example with argument unpacking

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

# describe_document method definition

def describe_document(
    self,
    *,
    Name: str,
    DocumentVersion: str = ...,
    VersionName: str = ...,
) -> DescribeDocumentResultTypeDef:  # (1)
    ...

1. See DescribeDocumentResultTypeDef

# describe_document method usage example with argument unpacking

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

# describe_document_permission method definition

def describe_document_permission(
    self,
    *,
    Name: str,
    PermissionType: DocumentPermissionTypeType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeDocumentPermissionResponseTypeDef:  # (2)
    ...

1. See DocumentPermissionTypeType
2. See DescribeDocumentPermissionResponseTypeDef

# describe_document_permission method usage example with argument unpacking

kwargs: DescribeDocumentPermissionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "PermissionType": ...,
}

parent.describe_document_permission(**kwargs)

1. See DescribeDocumentPermissionRequestRequestTypeDef

describe_effective_instance_associations

All associations for the managed nodes.

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

# describe_effective_instance_associations method definition

def describe_effective_instance_associations(
    self,
    *,
    InstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeEffectiveInstanceAssociationsResultTypeDef:  # (1)
    ...

1. See DescribeEffectiveInstanceAssociationsResultTypeDef

# describe_effective_instance_associations method usage example with argument unpacking

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

# describe_effective_patches_for_patch_baseline method definition

def describe_effective_patches_for_patch_baseline(
    self,
    *,
    BaselineId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeEffectivePatchesForPatchBaselineResultTypeDef:  # (1)
    ...

1. See DescribeEffectivePatchesForPatchBaselineResultTypeDef

# describe_effective_patches_for_patch_baseline method usage example with argument unpacking

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 nodes.

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

# describe_instance_associations_status method definition

def describe_instance_associations_status(
    self,
    *,
    InstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeInstanceAssociationsStatusResultTypeDef:  # (1)
    ...

1. See DescribeInstanceAssociationsStatusResultTypeDef

# describe_instance_associations_status method usage example with argument unpacking

kwargs: DescribeInstanceAssociationsStatusRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_instance_associations_status(**kwargs)

1. See DescribeInstanceAssociationsStatusRequestRequestTypeDef

describe_instance_information

Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.

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

# describe_instance_information 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

# describe_instance_information method usage example with argument unpacking

kwargs: DescribeInstanceInformationRequestRequestTypeDef = {  # (1)
    "InstanceInformationFilterList": ...,
}

parent.describe_instance_information(**kwargs)

1. See DescribeInstanceInformationRequestRequestTypeDef

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

# describe_instance_patch_states method definition

def describe_instance_patch_states(
    self,
    *,
    InstanceIds: Sequence[str],
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeInstancePatchStatesResultTypeDef:  # (1)
    ...

1. See DescribeInstancePatchStatesResultTypeDef

# describe_instance_patch_states method usage example with argument unpacking

kwargs: DescribeInstancePatchStatesRequestRequestTypeDef = {  # (1)
    "InstanceIds": ...,
}

parent.describe_instance_patch_states(**kwargs)

1. See DescribeInstancePatchStatesRequestRequestTypeDef

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

# describe_instance_patch_states_for_patch_group method definition

def describe_instance_patch_states_for_patch_group(
    self,
    *,
    PatchGroup: str,
    Filters: Sequence[InstancePatchStateFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeInstancePatchStatesForPatchGroupResultTypeDef:  # (2)
    ...

1. See InstancePatchStateFilterTypeDef
2. See DescribeInstancePatchStatesForPatchGroupResultTypeDef

# describe_instance_patch_states_for_patch_group method usage example with argument unpacking

kwargs: DescribeInstancePatchStatesForPatchGroupRequestRequestTypeDef = {  # (1)
    "PatchGroup": ...,
}

parent.describe_instance_patch_states_for_patch_group(**kwargs)

1. See DescribeInstancePatchStatesForPatchGroupRequestRequestTypeDef

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

# describe_instance_patches method definition

def describe_instance_patches(
    self,
    *,
    InstanceId: str,
    Filters: Sequence[PatchOrchestratorFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeInstancePatchesResultTypeDef:  # (2)
    ...

1. See PatchOrchestratorFilterTypeDef
2. See DescribeInstancePatchesResultTypeDef

# describe_instance_patches method usage example with argument unpacking

kwargs: DescribeInstancePatchesRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
}

parent.describe_instance_patches(**kwargs)

1. See DescribeInstancePatchesRequestRequestTypeDef

describe_instance_properties

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

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

# describe_instance_properties method definition

def describe_instance_properties(
    self,
    *,
    InstancePropertyFilterList: Sequence[InstancePropertyFilterTypeDef] = ...,  # (1)
    FiltersWithOperator: Sequence[InstancePropertyStringFilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeInstancePropertiesResultTypeDef:  # (3)
    ...

1. See InstancePropertyFilterTypeDef
2. See InstancePropertyStringFilterTypeDef
3. See DescribeInstancePropertiesResultTypeDef

# describe_instance_properties method usage example with argument unpacking

kwargs: DescribeInstancePropertiesRequestRequestTypeDef = {  # (1)
    "InstancePropertyFilterList": ...,
}

parent.describe_instance_properties(**kwargs)

1. See DescribeInstancePropertiesRequestRequestTypeDef

describe_inventory_deletions

Describes a specific delete inventory operation.

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

# describe_inventory_deletions method definition

def describe_inventory_deletions(
    self,
    *,
    DeletionId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeInventoryDeletionsResultTypeDef:  # (1)
    ...

1. See DescribeInventoryDeletionsResultTypeDef

# describe_inventory_deletions method usage example with argument unpacking

kwargs: DescribeInventoryDeletionsRequestRequestTypeDef = {  # (1)
    "DeletionId": ...,
}

parent.describe_inventory_deletions(**kwargs)

1. See DescribeInventoryDeletionsRequestRequestTypeDef

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

# describe_maintenance_window_execution_task_invocations method definition

def describe_maintenance_window_execution_task_invocations(
    self,
    *,
    WindowExecutionId: str,
    TaskId: str,
    Filters: Sequence[MaintenanceWindowFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMaintenanceWindowExecutionTaskInvocationsResultTypeDef:  # (2)
    ...

1. See MaintenanceWindowFilterTypeDef
2. See DescribeMaintenanceWindowExecutionTaskInvocationsResultTypeDef

# describe_maintenance_window_execution_task_invocations method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowExecutionTaskInvocationsRequestRequestTypeDef = {  # (1)
    "WindowExecutionId": ...,
    "TaskId": ...,
}

parent.describe_maintenance_window_execution_task_invocations(**kwargs)

1. See DescribeMaintenanceWindowExecutionTaskInvocationsRequestRequestTypeDef

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

# describe_maintenance_window_execution_tasks method definition

def describe_maintenance_window_execution_tasks(
    self,
    *,
    WindowExecutionId: str,
    Filters: Sequence[MaintenanceWindowFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMaintenanceWindowExecutionTasksResultTypeDef:  # (2)
    ...

1. See MaintenanceWindowFilterTypeDef
2. See DescribeMaintenanceWindowExecutionTasksResultTypeDef

# describe_maintenance_window_execution_tasks method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowExecutionTasksRequestRequestTypeDef = {  # (1)
    "WindowExecutionId": ...,
}

parent.describe_maintenance_window_execution_tasks(**kwargs)

1. See DescribeMaintenanceWindowExecutionTasksRequestRequestTypeDef

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

# describe_maintenance_window_executions method definition

def describe_maintenance_window_executions(
    self,
    *,
    WindowId: str,
    Filters: Sequence[MaintenanceWindowFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMaintenanceWindowExecutionsResultTypeDef:  # (2)
    ...

1. See MaintenanceWindowFilterTypeDef
2. See DescribeMaintenanceWindowExecutionsResultTypeDef

# describe_maintenance_window_executions method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowExecutionsRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.describe_maintenance_window_executions(**kwargs)

1. See DescribeMaintenanceWindowExecutionsRequestRequestTypeDef

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

# describe_maintenance_window_schedule method definition

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)
    ...

1. See TargetTypeDef
2. See MaintenanceWindowResourceTypeType
3. See PatchOrchestratorFilterTypeDef
4. See DescribeMaintenanceWindowScheduleResultTypeDef

# describe_maintenance_window_schedule method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowScheduleRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.describe_maintenance_window_schedule(**kwargs)

1. See DescribeMaintenanceWindowScheduleRequestRequestTypeDef

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

# describe_maintenance_window_targets method definition

def describe_maintenance_window_targets(
    self,
    *,
    WindowId: str,
    Filters: Sequence[MaintenanceWindowFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMaintenanceWindowTargetsResultTypeDef:  # (2)
    ...

1. See MaintenanceWindowFilterTypeDef
2. See DescribeMaintenanceWindowTargetsResultTypeDef

# describe_maintenance_window_targets method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowTargetsRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.describe_maintenance_window_targets(**kwargs)

1. See DescribeMaintenanceWindowTargetsRequestRequestTypeDef

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

# describe_maintenance_window_tasks method definition

def describe_maintenance_window_tasks(
    self,
    *,
    WindowId: str,
    Filters: Sequence[MaintenanceWindowFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMaintenanceWindowTasksResultTypeDef:  # (2)
    ...

1. See MaintenanceWindowFilterTypeDef
2. See DescribeMaintenanceWindowTasksResultTypeDef

# describe_maintenance_window_tasks method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowTasksRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.describe_maintenance_window_tasks(**kwargs)

1. See DescribeMaintenanceWindowTasksRequestRequestTypeDef

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

# describe_maintenance_windows method definition

def describe_maintenance_windows(
    self,
    *,
    Filters: Sequence[MaintenanceWindowFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMaintenanceWindowsResultTypeDef:  # (2)
    ...

1. See MaintenanceWindowFilterTypeDef
2. See DescribeMaintenanceWindowsResultTypeDef

# describe_maintenance_windows method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_maintenance_windows(**kwargs)

1. See DescribeMaintenanceWindowsRequestRequestTypeDef

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

# describe_maintenance_windows_for_target method definition

def describe_maintenance_windows_for_target(
    self,
    *,
    Targets: Sequence[TargetTypeDef],  # (1)
    ResourceType: MaintenanceWindowResourceTypeType,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeMaintenanceWindowsForTargetResultTypeDef:  # (3)
    ...

1. See TargetTypeDef
2. See MaintenanceWindowResourceTypeType
3. See DescribeMaintenanceWindowsForTargetResultTypeDef

# describe_maintenance_windows_for_target method usage example with argument unpacking

kwargs: DescribeMaintenanceWindowsForTargetRequestRequestTypeDef = {  # (1)
    "Targets": ...,
    "ResourceType": ...,
}

parent.describe_maintenance_windows_for_target(**kwargs)

1. See DescribeMaintenanceWindowsForTargetRequestRequestTypeDef

describe_ops_items

Query a set of OpsItems.

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

# describe_ops_items method definition

def describe_ops_items(
    self,
    *,
    OpsItemFilters: Sequence[OpsItemFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeOpsItemsResponseTypeDef:  # (2)
    ...

1. See OpsItemFilterTypeDef
2. See DescribeOpsItemsResponseTypeDef

# describe_ops_items method usage example with argument unpacking

kwargs: DescribeOpsItemsRequestRequestTypeDef = {  # (1)
    "OpsItemFilters": ...,
}

parent.describe_ops_items(**kwargs)

1. See DescribeOpsItemsRequestRequestTypeDef

describe_parameters

Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.

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

# describe_parameters method definition

def describe_parameters(
    self,
    *,
    Filters: Sequence[ParametersFilterTypeDef] = ...,  # (1)
    ParameterFilters: Sequence[ParameterStringFilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
    Shared: bool = ...,
) -> DescribeParametersResultTypeDef:  # (3)
    ...

1. See ParametersFilterTypeDef
2. See ParameterStringFilterTypeDef
3. See DescribeParametersResultTypeDef

# describe_parameters method usage example with argument unpacking

kwargs: DescribeParametersRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_parameters(**kwargs)

1. See DescribeParametersRequestRequestTypeDef

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

# describe_patch_baselines method definition

def describe_patch_baselines(
    self,
    *,
    Filters: Sequence[PatchOrchestratorFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribePatchBaselinesResultTypeDef:  # (2)
    ...

1. See PatchOrchestratorFilterTypeDef
2. See DescribePatchBaselinesResultTypeDef

# describe_patch_baselines method usage example with argument unpacking

kwargs: DescribePatchBaselinesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_patch_baselines(**kwargs)

1. See DescribePatchBaselinesRequestRequestTypeDef

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

# describe_patch_group_state method definition

def describe_patch_group_state(
    self,
    *,
    PatchGroup: str,
) -> DescribePatchGroupStateResultTypeDef:  # (1)
    ...

1. See DescribePatchGroupStateResultTypeDef

# describe_patch_group_state method usage example with argument unpacking

kwargs: DescribePatchGroupStateRequestRequestTypeDef = {  # (1)
    "PatchGroup": ...,
}

parent.describe_patch_group_state(**kwargs)

1. See DescribePatchGroupStateRequestRequestTypeDef

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

# describe_patch_groups method definition

def describe_patch_groups(
    self,
    *,
    MaxResults: int = ...,
    Filters: Sequence[PatchOrchestratorFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
) -> DescribePatchGroupsResultTypeDef:  # (2)
    ...

1. See PatchOrchestratorFilterTypeDef
2. See DescribePatchGroupsResultTypeDef

# describe_patch_groups method usage example with argument unpacking

kwargs: DescribePatchGroupsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.describe_patch_groups(**kwargs)

1. See DescribePatchGroupsRequestRequestTypeDef

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

# describe_patch_properties method definition

def describe_patch_properties(
    self,
    *,
    OperatingSystem: OperatingSystemType,  # (1)
    Property: PatchPropertyType,  # (2)
    PatchSet: PatchSetType = ...,  # (3)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribePatchPropertiesResultTypeDef:  # (4)
    ...

1. See OperatingSystemType
2. See PatchPropertyType
3. See PatchSetType
4. See DescribePatchPropertiesResultTypeDef

# describe_patch_properties method usage example with argument unpacking

kwargs: DescribePatchPropertiesRequestRequestTypeDef = {  # (1)
    "OperatingSystem": ...,
    "Property": ...,
}

parent.describe_patch_properties(**kwargs)

1. See DescribePatchPropertiesRequestRequestTypeDef

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

# describe_sessions method definition

def describe_sessions(
    self,
    *,
    State: SessionStateType,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[SessionFilterTypeDef] = ...,  # (2)
) -> DescribeSessionsResponseTypeDef:  # (3)
    ...

1. See SessionStateType
2. See SessionFilterTypeDef
3. See DescribeSessionsResponseTypeDef

# describe_sessions method usage example with argument unpacking

kwargs: DescribeSessionsRequestRequestTypeDef = {  # (1)
    "State": ...,
}

parent.describe_sessions(**kwargs)

1. See DescribeSessionsRequestRequestTypeDef

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

# disassociate_ops_item_related_item method definition

def disassociate_ops_item_related_item(
    self,
    *,
    OpsItemId: str,
    AssociationId: str,
) -> dict[str, Any]:
    ...

# disassociate_ops_item_related_item method usage example with argument unpacking

kwargs: DisassociateOpsItemRelatedItemRequestRequestTypeDef = {  # (1)
    "OpsItemId": ...,
    "AssociationId": ...,
}

parent.disassociate_ops_item_related_item(**kwargs)

1. See DisassociateOpsItemRelatedItemRequestRequestTypeDef

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

# get_automation_execution method definition

def get_automation_execution(
    self,
    *,
    AutomationExecutionId: str,
) -> GetAutomationExecutionResultTypeDef:  # (1)
    ...

1. See GetAutomationExecutionResultTypeDef

# get_automation_execution method usage example with argument unpacking

kwargs: GetAutomationExecutionRequestRequestTypeDef = {  # (1)
    "AutomationExecutionId": ...,
}

parent.get_automation_execution(**kwargs)

1. See GetAutomationExecutionRequestRequestTypeDef

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

# get_calendar_state method definition

def get_calendar_state(
    self,
    *,
    CalendarNames: Sequence[str],
    AtTime: str = ...,
) -> GetCalendarStateResponseTypeDef:  # (1)
    ...

1. See GetCalendarStateResponseTypeDef

# get_calendar_state method usage example with argument unpacking

kwargs: GetCalendarStateRequestRequestTypeDef = {  # (1)
    "CalendarNames": ...,
}

parent.get_calendar_state(**kwargs)

1. See GetCalendarStateRequestRequestTypeDef

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

# get_command_invocation method definition

def get_command_invocation(
    self,
    *,
    CommandId: str,
    InstanceId: str,
    PluginName: str = ...,
) -> GetCommandInvocationResultTypeDef:  # (1)
    ...

1. See GetCommandInvocationResultTypeDef

# get_command_invocation method usage example with argument unpacking

kwargs: GetCommandInvocationRequestRequestTypeDef = {  # (1)
    "CommandId": ...,
    "InstanceId": ...,
}

parent.get_command_invocation(**kwargs)

1. See GetCommandInvocationRequestRequestTypeDef

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

# get_connection_status method definition

def get_connection_status(
    self,
    *,
    Target: str,
) -> GetConnectionStatusResponseTypeDef:  # (1)
    ...

1. See GetConnectionStatusResponseTypeDef

# get_connection_status method usage example with argument unpacking

kwargs: GetConnectionStatusRequestRequestTypeDef = {  # (1)
    "Target": ...,
}

parent.get_connection_status(**kwargs)

1. See GetConnectionStatusRequestRequestTypeDef

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

# get_default_patch_baseline method definition

def get_default_patch_baseline(
    self,
    *,
    OperatingSystem: OperatingSystemType = ...,  # (1)
) -> GetDefaultPatchBaselineResultTypeDef:  # (2)
    ...

1. See OperatingSystemType
2. See GetDefaultPatchBaselineResultTypeDef

# get_default_patch_baseline method usage example with argument unpacking

kwargs: GetDefaultPatchBaselineRequestRequestTypeDef = {  # (1)
    "OperatingSystem": ...,
}

parent.get_default_patch_baseline(**kwargs)

1. See GetDefaultPatchBaselineRequestRequestTypeDef

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

# get_deployable_patch_snapshot_for_instance method definition

def get_deployable_patch_snapshot_for_instance(
    self,
    *,
    InstanceId: str,
    SnapshotId: str,
    BaselineOverride: BaselineOverrideTypeDef = ...,  # (1)
) -> GetDeployablePatchSnapshotForInstanceResultTypeDef:  # (2)
    ...

1. See BaselineOverrideTypeDef
2. See GetDeployablePatchSnapshotForInstanceResultTypeDef

# get_deployable_patch_snapshot_for_instance method usage example with argument unpacking

kwargs: GetDeployablePatchSnapshotForInstanceRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "SnapshotId": ...,
}

parent.get_deployable_patch_snapshot_for_instance(**kwargs)

1. See GetDeployablePatchSnapshotForInstanceRequestRequestTypeDef

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

# get_document method definition

def get_document(
    self,
    *,
    Name: str,
    VersionName: str = ...,
    DocumentVersion: str = ...,
    DocumentFormat: DocumentFormatType = ...,  # (1)
) -> GetDocumentResultTypeDef:  # (2)
    ...

1. See DocumentFormatType
2. See GetDocumentResultTypeDef

# get_document method usage example with argument unpacking

kwargs: GetDocumentRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_document(**kwargs)

1. See GetDocumentRequestRequestTypeDef

get_execution_preview

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

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

# get_execution_preview method definition

def get_execution_preview(
    self,
    *,
    ExecutionPreviewId: str,
) -> GetExecutionPreviewResponseTypeDef:  # (1)
    ...

1. See GetExecutionPreviewResponseTypeDef

# get_execution_preview method usage example with argument unpacking

kwargs: GetExecutionPreviewRequestRequestTypeDef = {  # (1)
    "ExecutionPreviewId": ...,
}

parent.get_execution_preview(**kwargs)

1. See GetExecutionPreviewRequestRequestTypeDef

get_inventory

Query inventory information.

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

# get_inventory method definition

def get_inventory(
    self,
    *,
    Filters: Sequence[InventoryFilterTypeDef] = ...,  # (1)
    Aggregators: Sequence[InventoryAggregatorTypeDef] = ...,  # (2)
    ResultAttributes: Sequence[ResultAttributeTypeDef] = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetInventoryResultTypeDef:  # (4)
    ...

1. See InventoryFilterTypeDef
2. See InventoryAggregatorTypeDef
3. See ResultAttributeTypeDef
4. See GetInventoryResultTypeDef

# get_inventory method usage example with argument unpacking

kwargs: GetInventoryRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.get_inventory(**kwargs)

1. See GetInventoryRequestRequestTypeDef

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

# get_inventory_schema method definition

def get_inventory_schema(
    self,
    *,
    TypeName: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Aggregator: bool = ...,
    SubType: bool = ...,
) -> GetInventorySchemaResultTypeDef:  # (1)
    ...

1. See GetInventorySchemaResultTypeDef

# get_inventory_schema method usage example with argument unpacking

kwargs: GetInventorySchemaRequestRequestTypeDef = {  # (1)
    "TypeName": ...,
}

parent.get_inventory_schema(**kwargs)

1. See GetInventorySchemaRequestRequestTypeDef

get_maintenance_window

Retrieves a maintenance window.

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

# get_maintenance_window method definition

def get_maintenance_window(
    self,
    *,
    WindowId: str,
) -> GetMaintenanceWindowResultTypeDef:  # (1)
    ...

1. See GetMaintenanceWindowResultTypeDef

# get_maintenance_window method usage example with argument unpacking

kwargs: GetMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.get_maintenance_window(**kwargs)

1. See GetMaintenanceWindowRequestRequestTypeDef

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

# get_maintenance_window_execution method definition

def get_maintenance_window_execution(
    self,
    *,
    WindowExecutionId: str,
) -> GetMaintenanceWindowExecutionResultTypeDef:  # (1)
    ...

1. See GetMaintenanceWindowExecutionResultTypeDef

# get_maintenance_window_execution method usage example with argument unpacking

kwargs: GetMaintenanceWindowExecutionRequestRequestTypeDef = {  # (1)
    "WindowExecutionId": ...,
}

parent.get_maintenance_window_execution(**kwargs)

1. See GetMaintenanceWindowExecutionRequestRequestTypeDef

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

# get_maintenance_window_execution_task method definition

def get_maintenance_window_execution_task(
    self,
    *,
    WindowExecutionId: str,
    TaskId: str,
) -> GetMaintenanceWindowExecutionTaskResultTypeDef:  # (1)
    ...

1. See GetMaintenanceWindowExecutionTaskResultTypeDef

# get_maintenance_window_execution_task method usage example with argument unpacking

kwargs: GetMaintenanceWindowExecutionTaskRequestRequestTypeDef = {  # (1)
    "WindowExecutionId": ...,
    "TaskId": ...,
}

parent.get_maintenance_window_execution_task(**kwargs)

1. See GetMaintenanceWindowExecutionTaskRequestRequestTypeDef

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

# get_maintenance_window_execution_task_invocation method definition

def get_maintenance_window_execution_task_invocation(
    self,
    *,
    WindowExecutionId: str,
    TaskId: str,
    InvocationId: str,
) -> GetMaintenanceWindowExecutionTaskInvocationResultTypeDef:  # (1)
    ...

1. See GetMaintenanceWindowExecutionTaskInvocationResultTypeDef

# get_maintenance_window_execution_task_invocation method usage example with argument unpacking

kwargs: GetMaintenanceWindowExecutionTaskInvocationRequestRequestTypeDef = {  # (1)
    "WindowExecutionId": ...,
    "TaskId": ...,
    "InvocationId": ...,
}

parent.get_maintenance_window_execution_task_invocation(**kwargs)

1. See GetMaintenanceWindowExecutionTaskInvocationRequestRequestTypeDef

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

# get_maintenance_window_task method definition

def get_maintenance_window_task(
    self,
    *,
    WindowId: str,
    WindowTaskId: str,
) -> GetMaintenanceWindowTaskResultTypeDef:  # (1)
    ...

1. See GetMaintenanceWindowTaskResultTypeDef

# get_maintenance_window_task method usage example with argument unpacking

kwargs: GetMaintenanceWindowTaskRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
    "WindowTaskId": ...,
}

parent.get_maintenance_window_task(**kwargs)

1. See GetMaintenanceWindowTaskRequestRequestTypeDef

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

# get_ops_item method definition

def get_ops_item(
    self,
    *,
    OpsItemId: str,
    OpsItemArn: str = ...,
) -> GetOpsItemResponseTypeDef:  # (1)
    ...

1. See GetOpsItemResponseTypeDef

# get_ops_item method usage example with argument unpacking

kwargs: GetOpsItemRequestRequestTypeDef = {  # (1)
    "OpsItemId": ...,
}

parent.get_ops_item(**kwargs)

1. See GetOpsItemRequestRequestTypeDef

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

# get_ops_metadata method definition

def get_ops_metadata(
    self,
    *,
    OpsMetadataArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetOpsMetadataResultTypeDef:  # (1)
    ...

1. See GetOpsMetadataResultTypeDef

# get_ops_metadata method usage example with argument unpacking

kwargs: GetOpsMetadataRequestRequestTypeDef = {  # (1)
    "OpsMetadataArn": ...,
}

parent.get_ops_metadata(**kwargs)

1. See GetOpsMetadataRequestRequestTypeDef

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

# get_ops_summary method definition

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)
    ...

1. See OpsFilterTypeDef
2. See OpsAggregatorTypeDef
3. See OpsResultAttributeTypeDef
4. See GetOpsSummaryResultTypeDef

# get_ops_summary method usage example with argument unpacking

kwargs: GetOpsSummaryRequestRequestTypeDef = {  # (1)
    "SyncName": ...,
}

parent.get_ops_summary(**kwargs)

1. See GetOpsSummaryRequestRequestTypeDef

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

# get_parameter method definition

def get_parameter(
    self,
    *,
    Name: str,
    WithDecryption: bool = ...,
) -> GetParameterResultTypeDef:  # (1)
    ...

1. See GetParameterResultTypeDef

# get_parameter method usage example with argument unpacking

kwargs: GetParameterRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_parameter(**kwargs)

1. See GetParameterRequestRequestTypeDef

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

# get_parameter_history method definition

def get_parameter_history(
    self,
    *,
    Name: str,
    WithDecryption: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetParameterHistoryResultTypeDef:  # (1)
    ...

1. See GetParameterHistoryResultTypeDef

# get_parameter_history method usage example with argument unpacking

kwargs: GetParameterHistoryRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.get_parameter_history(**kwargs)

1. See GetParameterHistoryRequestRequestTypeDef

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

# get_parameters method definition

def get_parameters(
    self,
    *,
    Names: Sequence[str],
    WithDecryption: bool = ...,
) -> GetParametersResultTypeDef:  # (1)
    ...

1. See GetParametersResultTypeDef

# get_parameters method usage example with argument unpacking

kwargs: GetParametersRequestRequestTypeDef = {  # (1)
    "Names": ...,
}

parent.get_parameters(**kwargs)

1. See GetParametersRequestRequestTypeDef

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

# get_parameters_by_path method definition

def get_parameters_by_path(
    self,
    *,
    Path: str,
    Recursive: bool = ...,
    ParameterFilters: Sequence[ParameterStringFilterTypeDef] = ...,  # (1)
    WithDecryption: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetParametersByPathResultTypeDef:  # (2)
    ...

1. See ParameterStringFilterTypeDef
2. See GetParametersByPathResultTypeDef

# get_parameters_by_path method usage example with argument unpacking

kwargs: GetParametersByPathRequestRequestTypeDef = {  # (1)
    "Path": ...,
}

parent.get_parameters_by_path(**kwargs)

1. See GetParametersByPathRequestRequestTypeDef

get_patch_baseline

Retrieves information about a patch baseline.

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

# get_patch_baseline method definition

def get_patch_baseline(
    self,
    *,
    BaselineId: str,
) -> GetPatchBaselineResultTypeDef:  # (1)
    ...

1. See GetPatchBaselineResultTypeDef

# get_patch_baseline method usage example with argument unpacking

kwargs: GetPatchBaselineRequestRequestTypeDef = {  # (1)
    "BaselineId": ...,
}

parent.get_patch_baseline(**kwargs)

1. See GetPatchBaselineRequestRequestTypeDef

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

# get_patch_baseline_for_patch_group method definition

def get_patch_baseline_for_patch_group(
    self,
    *,
    PatchGroup: str,
    OperatingSystem: OperatingSystemType = ...,  # (1)
) -> GetPatchBaselineForPatchGroupResultTypeDef:  # (2)
    ...

1. See OperatingSystemType
2. See GetPatchBaselineForPatchGroupResultTypeDef

# get_patch_baseline_for_patch_group method usage example with argument unpacking

kwargs: GetPatchBaselineForPatchGroupRequestRequestTypeDef = {  # (1)
    "PatchGroup": ...,
}

parent.get_patch_baseline_for_patch_group(**kwargs)

1. See GetPatchBaselineForPatchGroupRequestRequestTypeDef

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

# get_resource_policies method definition

def get_resource_policies(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetResourcePoliciesResponseTypeDef:  # (1)
    ...

1. See GetResourcePoliciesResponseTypeDef

# get_resource_policies method usage example with argument unpacking

kwargs: GetResourcePoliciesRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_resource_policies(**kwargs)

1. See GetResourcePoliciesRequestRequestTypeDef

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

# get_service_setting method definition

def get_service_setting(
    self,
    *,
    SettingId: str,
) -> GetServiceSettingResultTypeDef:  # (1)
    ...

1. See GetServiceSettingResultTypeDef

# get_service_setting method usage example with argument unpacking

kwargs: GetServiceSettingRequestRequestTypeDef = {  # (1)
    "SettingId": ...,
}

parent.get_service_setting(**kwargs)

1. See GetServiceSettingRequestRequestTypeDef

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

# label_parameter_version method definition

def label_parameter_version(
    self,
    *,
    Name: str,
    Labels: Sequence[str],
    ParameterVersion: int = ...,
) -> LabelParameterVersionResultTypeDef:  # (1)
    ...

1. See LabelParameterVersionResultTypeDef

# label_parameter_version method usage example with argument unpacking

kwargs: LabelParameterVersionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Labels": ...,
}

parent.label_parameter_version(**kwargs)

1. See LabelParameterVersionRequestRequestTypeDef

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

# list_association_versions method definition

def list_association_versions(
    self,
    *,
    AssociationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAssociationVersionsResultTypeDef:  # (1)
    ...

1. See ListAssociationVersionsResultTypeDef

# list_association_versions method usage example with argument unpacking

kwargs: ListAssociationVersionsRequestRequestTypeDef = {  # (1)
    "AssociationId": ...,
}

parent.list_association_versions(**kwargs)

1. See ListAssociationVersionsRequestRequestTypeDef

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

# list_associations method definition

def list_associations(
    self,
    *,
    AssociationFilterList: Sequence[AssociationFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAssociationsResultTypeDef:  # (2)
    ...

1. See AssociationFilterTypeDef
2. See ListAssociationsResultTypeDef

# list_associations method usage example with argument unpacking

kwargs: ListAssociationsRequestRequestTypeDef = {  # (1)
    "AssociationFilterList": ...,
}

parent.list_associations(**kwargs)

1. See ListAssociationsRequestRequestTypeDef

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

# list_command_invocations method definition

def list_command_invocations(
    self,
    *,
    CommandId: str = ...,
    InstanceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[CommandFilterTypeDef] = ...,  # (1)
    Details: bool = ...,
) -> ListCommandInvocationsResultTypeDef:  # (2)
    ...

1. See CommandFilterTypeDef
2. See ListCommandInvocationsResultTypeDef

# list_command_invocations method usage example with argument unpacking

kwargs: ListCommandInvocationsRequestRequestTypeDef = {  # (1)
    "CommandId": ...,
}

parent.list_command_invocations(**kwargs)

1. See ListCommandInvocationsRequestRequestTypeDef

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

# list_commands method definition

def list_commands(
    self,
    *,
    CommandId: str = ...,
    InstanceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[CommandFilterTypeDef] = ...,  # (1)
) -> ListCommandsResultTypeDef:  # (2)
    ...

1. See CommandFilterTypeDef
2. See ListCommandsResultTypeDef

# list_commands method usage example with argument unpacking

kwargs: ListCommandsRequestRequestTypeDef = {  # (1)
    "CommandId": ...,
}

parent.list_commands(**kwargs)

1. See ListCommandsRequestRequestTypeDef

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

# list_compliance_items method definition

def list_compliance_items(
    self,
    *,
    Filters: Sequence[ComplianceStringFilterTypeDef] = ...,  # (1)
    ResourceIds: Sequence[str] = ...,
    ResourceTypes: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListComplianceItemsResultTypeDef:  # (2)
    ...

1. See ComplianceStringFilterTypeDef
2. See ListComplianceItemsResultTypeDef

# list_compliance_items method usage example with argument unpacking

kwargs: ListComplianceItemsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_compliance_items(**kwargs)

1. See ListComplianceItemsRequestRequestTypeDef

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

# list_compliance_summaries method definition

def list_compliance_summaries(
    self,
    *,
    Filters: Sequence[ComplianceStringFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListComplianceSummariesResultTypeDef:  # (2)
    ...

1. See ComplianceStringFilterTypeDef
2. See ListComplianceSummariesResultTypeDef

# list_compliance_summaries method usage example with argument unpacking

kwargs: ListComplianceSummariesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_compliance_summaries(**kwargs)

1. See ListComplianceSummariesRequestRequestTypeDef

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

# list_document_metadata_history method definition

def list_document_metadata_history(
    self,
    *,
    Name: str,
    Metadata: DocumentMetadataEnumType,  # (1)
    DocumentVersion: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDocumentMetadataHistoryResponseTypeDef:  # (2)
    ...

1. See DocumentMetadataEnumType
2. See ListDocumentMetadataHistoryResponseTypeDef

# list_document_metadata_history method usage example with argument unpacking

kwargs: ListDocumentMetadataHistoryRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Metadata": ...,
}

parent.list_document_metadata_history(**kwargs)

1. See ListDocumentMetadataHistoryRequestRequestTypeDef

list_document_versions

List all versions for a document.

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

# list_document_versions method definition

def list_document_versions(
    self,
    *,
    Name: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDocumentVersionsResultTypeDef:  # (1)
    ...

1. See ListDocumentVersionsResultTypeDef

# list_document_versions method usage example with argument unpacking

kwargs: ListDocumentVersionsRequestRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.list_document_versions(**kwargs)

1. See ListDocumentVersionsRequestRequestTypeDef

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

# list_documents method definition

def list_documents(
    self,
    *,
    DocumentFilterList: Sequence[DocumentFilterTypeDef] = ...,  # (1)
    Filters: Sequence[DocumentKeyValuesFilterTypeDef] = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDocumentsResultTypeDef:  # (3)
    ...

1. See DocumentFilterTypeDef
2. See DocumentKeyValuesFilterTypeDef
3. See ListDocumentsResultTypeDef

# list_documents method usage example with argument unpacking

kwargs: ListDocumentsRequestRequestTypeDef = {  # (1)
    "DocumentFilterList": ...,
}

parent.list_documents(**kwargs)

1. See ListDocumentsRequestRequestTypeDef

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

# list_inventory_entries method definition

def list_inventory_entries(
    self,
    *,
    InstanceId: str,
    TypeName: str,
    Filters: Sequence[InventoryFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListInventoryEntriesResultTypeDef:  # (2)
    ...

1. See InventoryFilterTypeDef
2. See ListInventoryEntriesResultTypeDef

# list_inventory_entries method usage example with argument unpacking

kwargs: ListInventoryEntriesRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "TypeName": ...,
}

parent.list_inventory_entries(**kwargs)

1. See ListInventoryEntriesRequestRequestTypeDef

list_nodes

Takes in filters and returns a list of managed nodes matching the filter criteria.

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

# list_nodes method definition

def list_nodes(
    self,
    *,
    SyncName: str = ...,
    Filters: Sequence[NodeFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListNodesResultTypeDef:  # (2)
    ...

1. See NodeFilterTypeDef
2. See ListNodesResultTypeDef

# list_nodes method usage example with argument unpacking

kwargs: ListNodesRequestRequestTypeDef = {  # (1)
    "SyncName": ...,
}

parent.list_nodes(**kwargs)

1. See ListNodesRequestRequestTypeDef

list_nodes_summary

Generates a summary of managed instance/node metadata based on the filters and aggregators you specify.

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

# list_nodes_summary method definition

def list_nodes_summary(
    self,
    *,
    Aggregators: Sequence[NodeAggregatorTypeDef],  # (1)
    SyncName: str = ...,
    Filters: Sequence[NodeFilterTypeDef] = ...,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListNodesSummaryResultTypeDef:  # (3)
    ...

1. See NodeAggregatorTypeDef
2. See NodeFilterTypeDef
3. See ListNodesSummaryResultTypeDef

# list_nodes_summary method usage example with argument unpacking

kwargs: ListNodesSummaryRequestRequestTypeDef = {  # (1)
    "Aggregators": ...,
}

parent.list_nodes_summary(**kwargs)

1. See ListNodesSummaryRequestRequestTypeDef

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

# list_ops_item_events method definition

def list_ops_item_events(
    self,
    *,
    Filters: Sequence[OpsItemEventFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOpsItemEventsResponseTypeDef:  # (2)
    ...

1. See OpsItemEventFilterTypeDef
2. See ListOpsItemEventsResponseTypeDef

# list_ops_item_events method usage example with argument unpacking

kwargs: ListOpsItemEventsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_ops_item_events(**kwargs)

1. See ListOpsItemEventsRequestRequestTypeDef

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

# list_ops_item_related_items method definition

def list_ops_item_related_items(
    self,
    *,
    OpsItemId: str = ...,
    Filters: Sequence[OpsItemRelatedItemsFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOpsItemRelatedItemsResponseTypeDef:  # (2)
    ...

1. See OpsItemRelatedItemsFilterTypeDef
2. See ListOpsItemRelatedItemsResponseTypeDef

# list_ops_item_related_items method usage example with argument unpacking

kwargs: ListOpsItemRelatedItemsRequestRequestTypeDef = {  # (1)
    "OpsItemId": ...,
}

parent.list_ops_item_related_items(**kwargs)

1. See ListOpsItemRelatedItemsRequestRequestTypeDef

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

# list_ops_metadata method definition

def list_ops_metadata(
    self,
    *,
    Filters: Sequence[OpsMetadataFilterTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOpsMetadataResultTypeDef:  # (2)
    ...

1. See OpsMetadataFilterTypeDef
2. See ListOpsMetadataResultTypeDef

# list_ops_metadata method usage example with argument unpacking

kwargs: ListOpsMetadataRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_ops_metadata(**kwargs)

1. See ListOpsMetadataRequestRequestTypeDef

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

# list_resource_compliance_summaries method definition

def list_resource_compliance_summaries(
    self,
    *,
    Filters: Sequence[ComplianceStringFilterTypeDef] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourceComplianceSummariesResultTypeDef:  # (2)
    ...

1. See ComplianceStringFilterTypeDef
2. See ListResourceComplianceSummariesResultTypeDef

# list_resource_compliance_summaries method usage example with argument unpacking

kwargs: ListResourceComplianceSummariesRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_resource_compliance_summaries(**kwargs)

1. See ListResourceComplianceSummariesRequestRequestTypeDef

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

# list_resource_data_sync method definition

def list_resource_data_sync(
    self,
    *,
    SyncType: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourceDataSyncResultTypeDef:  # (1)
    ...

1. See ListResourceDataSyncResultTypeDef

# list_resource_data_sync method usage example with argument unpacking

kwargs: ListResourceDataSyncRequestRequestTypeDef = {  # (1)
    "SyncType": ...,
}

parent.list_resource_data_sync(**kwargs)

1. See ListResourceDataSyncRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceType: ResourceTypeForTaggingType,  # (1)
    ResourceId: str,
) -> ListTagsForResourceResultTypeDef:  # (2)
    ...

1. See ResourceTypeForTaggingType
2. See ListTagsForResourceResultTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
    "ResourceId": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

# modify_document_permission method definition

def modify_document_permission(
    self,
    *,
    Name: str,
    PermissionType: DocumentPermissionTypeType,  # (1)
    AccountIdsToAdd: Sequence[str] = ...,
    AccountIdsToRemove: Sequence[str] = ...,
    SharedDocumentVersion: str = ...,
) -> dict[str, Any]:
    ...

1. See DocumentPermissionTypeType

# modify_document_permission method usage example with argument unpacking

kwargs: ModifyDocumentPermissionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "PermissionType": ...,
}

parent.modify_document_permission(**kwargs)

1. See ModifyDocumentPermissionRequestRequestTypeDef

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

# put_compliance_items method definition

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]:
    ...

1. See ComplianceExecutionSummaryTypeDef
2. See ComplianceItemEntryTypeDef
3. See ComplianceUploadTypeType

# put_compliance_items method usage example with argument unpacking

kwargs: PutComplianceItemsRequestRequestTypeDef = {  # (1)
    "ResourceId": ...,
    "ResourceType": ...,
    "ComplianceType": ...,
    "ExecutionSummary": ...,
    "Items": ...,
}

parent.put_compliance_items(**kwargs)

1. See PutComplianceItemsRequestRequestTypeDef

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

# put_inventory method definition

def put_inventory(
    self,
    *,
    InstanceId: str,
    Items: Sequence[InventoryItemTypeDef],  # (1)
) -> PutInventoryResultTypeDef:  # (2)
    ...

1. See InventoryItemTypeDef
2. See PutInventoryResultTypeDef

# put_inventory method usage example with argument unpacking

kwargs: PutInventoryRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "Items": ...,
}

parent.put_inventory(**kwargs)

1. See PutInventoryRequestRequestTypeDef

put_parameter

Add a parameter to the system.

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

# put_parameter method definition

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)
    ...

1. See ParameterTypeType
2. See TagTypeDef
3. See ParameterTierType
4. See PutParameterResultTypeDef

# put_parameter method usage example with argument unpacking

kwargs: PutParameterRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Value": ...,
}

parent.put_parameter(**kwargs)

1. See PutParameterRequestRequestTypeDef

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

# put_resource_policy method definition

def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
    PolicyId: str = ...,
    PolicyHash: str = ...,
) -> PutResourcePolicyResponseTypeDef:  # (1)
    ...

1. See PutResourcePolicyResponseTypeDef

# put_resource_policy method usage example with argument unpacking

kwargs: PutResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyRequestRequestTypeDef

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

# register_default_patch_baseline method definition

def register_default_patch_baseline(
    self,
    *,
    BaselineId: str,
) -> RegisterDefaultPatchBaselineResultTypeDef:  # (1)
    ...

1. See RegisterDefaultPatchBaselineResultTypeDef

# register_default_patch_baseline method usage example with argument unpacking

kwargs: RegisterDefaultPatchBaselineRequestRequestTypeDef = {  # (1)
    "BaselineId": ...,
}

parent.register_default_patch_baseline(**kwargs)

1. See RegisterDefaultPatchBaselineRequestRequestTypeDef

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

# register_patch_baseline_for_patch_group method definition

def register_patch_baseline_for_patch_group(
    self,
    *,
    BaselineId: str,
    PatchGroup: str,
) -> RegisterPatchBaselineForPatchGroupResultTypeDef:  # (1)
    ...

1. See RegisterPatchBaselineForPatchGroupResultTypeDef

# register_patch_baseline_for_patch_group method usage example with argument unpacking

kwargs: RegisterPatchBaselineForPatchGroupRequestRequestTypeDef = {  # (1)
    "BaselineId": ...,
    "PatchGroup": ...,
}

parent.register_patch_baseline_for_patch_group(**kwargs)

1. See RegisterPatchBaselineForPatchGroupRequestRequestTypeDef

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

# register_target_with_maintenance_window method definition

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)
    ...

1. See MaintenanceWindowResourceTypeType
2. See TargetTypeDef
3. See RegisterTargetWithMaintenanceWindowResultTypeDef

# register_target_with_maintenance_window method usage example with argument unpacking

kwargs: RegisterTargetWithMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
    "ResourceType": ...,
    "Targets": ...,
}

parent.register_target_with_maintenance_window(**kwargs)

1. See RegisterTargetWithMaintenanceWindowRequestRequestTypeDef

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

# register_task_with_maintenance_window method definition

def register_task_with_maintenance_window(
    self,
    *,
    WindowId: str,
    TaskArn: str,
    TaskType: MaintenanceWindowTaskTypeType,  # (1)
    Targets: Sequence[TargetTypeDef] = ...,  # (2)
    ServiceRoleArn: str = ...,
    TaskParameters: Mapping[str, MaintenanceWindowTaskParameterValueExpressionUnionTypeDef] = ...,  # (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)
    ...

1. See MaintenanceWindowTaskTypeType
2. See TargetTypeDef
3. See MaintenanceWindowTaskParameterValueExpressionTypeDef MaintenanceWindowTaskParameterValueExpressionOutputTypeDef
4. See MaintenanceWindowTaskInvocationParametersTypeDef
5. See LoggingInfoTypeDef
6. See MaintenanceWindowTaskCutoffBehaviorType
7. See AlarmConfigurationTypeDef
8. See RegisterTaskWithMaintenanceWindowResultTypeDef

# register_task_with_maintenance_window method usage example with argument unpacking

kwargs: RegisterTaskWithMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
    "TaskArn": ...,
    "TaskType": ...,
}

parent.register_task_with_maintenance_window(**kwargs)

1. See RegisterTaskWithMaintenanceWindowRequestRequestTypeDef

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

# remove_tags_from_resource method definition

def remove_tags_from_resource(
    self,
    *,
    ResourceType: ResourceTypeForTaggingType,  # (1)
    ResourceId: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...

1. See ResourceTypeForTaggingType

# remove_tags_from_resource method usage example with argument unpacking

kwargs: RemoveTagsFromResourceRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
    "ResourceId": ...,
    "TagKeys": ...,
}

parent.remove_tags_from_resource(**kwargs)

1. See RemoveTagsFromResourceRequestRequestTypeDef

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

# reset_service_setting method definition

def reset_service_setting(
    self,
    *,
    SettingId: str,
) -> ResetServiceSettingResultTypeDef:  # (1)
    ...

1. See ResetServiceSettingResultTypeDef

# reset_service_setting method usage example with argument unpacking

kwargs: ResetServiceSettingRequestRequestTypeDef = {  # (1)
    "SettingId": ...,
}

parent.reset_service_setting(**kwargs)

1. See ResetServiceSettingRequestRequestTypeDef

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

# resume_session method definition

def resume_session(
    self,
    *,
    SessionId: str,
) -> ResumeSessionResponseTypeDef:  # (1)
    ...

1. See ResumeSessionResponseTypeDef

# resume_session method usage example with argument unpacking

kwargs: ResumeSessionRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.resume_session(**kwargs)

1. See ResumeSessionRequestRequestTypeDef

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

# send_automation_signal method definition

def send_automation_signal(
    self,
    *,
    AutomationExecutionId: str,
    SignalType: SignalTypeType,  # (1)
    Payload: Mapping[str, Sequence[str]] = ...,
) -> dict[str, Any]:
    ...

1. See SignalTypeType

# send_automation_signal method usage example with argument unpacking

kwargs: SendAutomationSignalRequestRequestTypeDef = {  # (1)
    "AutomationExecutionId": ...,
    "SignalType": ...,
}

parent.send_automation_signal(**kwargs)

1. See SendAutomationSignalRequestRequestTypeDef

send_command

Runs commands on one or more managed nodes.

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

# send_command method definition

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)
    ...

1. See TargetTypeDef
2. See DocumentHashTypeType
3. See NotificationConfigTypeDef
4. See CloudWatchOutputConfigTypeDef
5. See AlarmConfigurationTypeDef
6. See SendCommandResultTypeDef

# send_command method usage example with argument unpacking

kwargs: SendCommandRequestRequestTypeDef = {  # (1)
    "DocumentName": ...,
}

parent.send_command(**kwargs)

1. See SendCommandRequestRequestTypeDef

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

# start_associations_once method definition

def start_associations_once(
    self,
    *,
    AssociationIds: Sequence[str],
) -> dict[str, Any]:
    ...

# start_associations_once method usage example with argument unpacking

kwargs: StartAssociationsOnceRequestRequestTypeDef = {  # (1)
    "AssociationIds": ...,
}

parent.start_associations_once(**kwargs)

1. See StartAssociationsOnceRequestRequestTypeDef

start_automation_execution

Initiates execution of an Automation runbook.

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

# start_automation_execution method definition

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)
    TargetLocationsURL: str = ...,
) -> StartAutomationExecutionResultTypeDef:  # (6)
    ...

1. See ExecutionModeType
2. See TargetTypeDef
3. See TargetLocationTypeDef
4. See TagTypeDef
5. See AlarmConfigurationTypeDef
6. See StartAutomationExecutionResultTypeDef

# start_automation_execution method usage example with argument unpacking

kwargs: StartAutomationExecutionRequestRequestTypeDef = {  # (1)
    "DocumentName": ...,
}

parent.start_automation_execution(**kwargs)

1. See StartAutomationExecutionRequestRequestTypeDef

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

# start_change_request_execution method definition

def start_change_request_execution(
    self,
    *,
    DocumentName: str,
    Runbooks: Sequence[RunbookUnionTypeDef],  # (1)
    ScheduledTime: TimestampTypeDef = ...,
    DocumentVersion: str = ...,
    Parameters: Mapping[str, Sequence[str]] = ...,
    ChangeRequestName: str = ...,
    ClientToken: str = ...,
    AutoApprove: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ScheduledEndTime: TimestampTypeDef = ...,
    ChangeDetails: str = ...,
) -> StartChangeRequestExecutionResultTypeDef:  # (3)
    ...

1. See RunbookTypeDef RunbookOutputTypeDef
2. See TagTypeDef
3. See StartChangeRequestExecutionResultTypeDef

# start_change_request_execution method usage example with argument unpacking

kwargs: StartChangeRequestExecutionRequestRequestTypeDef = {  # (1)
    "DocumentName": ...,
    "Runbooks": ...,
}

parent.start_change_request_execution(**kwargs)

1. See StartChangeRequestExecutionRequestRequestTypeDef

start_execution_preview

Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.

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

# start_execution_preview method definition

def start_execution_preview(
    self,
    *,
    DocumentName: str,
    DocumentVersion: str = ...,
    ExecutionInputs: ExecutionInputsTypeDef = ...,  # (1)
) -> StartExecutionPreviewResponseTypeDef:  # (2)
    ...

1. See ExecutionInputsTypeDef
2. See StartExecutionPreviewResponseTypeDef

# start_execution_preview method usage example with argument unpacking

kwargs: StartExecutionPreviewRequestRequestTypeDef = {  # (1)
    "DocumentName": ...,
}

parent.start_execution_preview(**kwargs)

1. See StartExecutionPreviewRequestRequestTypeDef

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

# start_session method definition

def start_session(
    self,
    *,
    Target: str,
    DocumentName: str = ...,
    Reason: str = ...,
    Parameters: Mapping[str, Sequence[str]] = ...,
) -> StartSessionResponseTypeDef:  # (1)
    ...

1. See StartSessionResponseTypeDef

# start_session method usage example with argument unpacking

kwargs: StartSessionRequestRequestTypeDef = {  # (1)
    "Target": ...,
}

parent.start_session(**kwargs)

1. See StartSessionRequestRequestTypeDef

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

# stop_automation_execution method definition

def stop_automation_execution(
    self,
    *,
    AutomationExecutionId: str,
    Type: StopTypeType = ...,  # (1)
) -> dict[str, Any]:
    ...

1. See StopTypeType

# stop_automation_execution method usage example with argument unpacking

kwargs: StopAutomationExecutionRequestRequestTypeDef = {  # (1)
    "AutomationExecutionId": ...,
}

parent.stop_automation_execution(**kwargs)

1. See StopAutomationExecutionRequestRequestTypeDef

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

# terminate_session method definition

def terminate_session(
    self,
    *,
    SessionId: str,
) -> TerminateSessionResponseTypeDef:  # (1)
    ...

1. See TerminateSessionResponseTypeDef

# terminate_session method usage example with argument unpacking

kwargs: TerminateSessionRequestRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.terminate_session(**kwargs)

1. See TerminateSessionRequestRequestTypeDef

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

# unlabel_parameter_version method definition

def unlabel_parameter_version(
    self,
    *,
    Name: str,
    ParameterVersion: int,
    Labels: Sequence[str],
) -> UnlabelParameterVersionResultTypeDef:  # (1)
    ...

1. See UnlabelParameterVersionResultTypeDef

# unlabel_parameter_version method usage example with argument unpacking

kwargs: UnlabelParameterVersionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ParameterVersion": ...,
    "Labels": ...,
}

parent.unlabel_parameter_version(**kwargs)

1. See UnlabelParameterVersionRequestRequestTypeDef

update_association

Updates an association.

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

# update_association method definition

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 = ...,
    Duration: int = ...,
    TargetMaps: Sequence[Mapping[str, Sequence[str]]] = ...,
    AlarmConfiguration: AlarmConfigurationTypeDef = ...,  # (6)
) -> UpdateAssociationResultTypeDef:  # (7)
    ...

1. See InstanceAssociationOutputLocationTypeDef
2. See TargetTypeDef
3. See AssociationComplianceSeverityType
4. See AssociationSyncComplianceType
5. See TargetLocationTypeDef
6. See AlarmConfigurationTypeDef
7. See UpdateAssociationResultTypeDef

# update_association method usage example with argument unpacking

kwargs: UpdateAssociationRequestRequestTypeDef = {  # (1)
    "AssociationId": ...,
}

parent.update_association(**kwargs)

1. See UpdateAssociationRequestRequestTypeDef

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

# update_association_status method definition

def update_association_status(
    self,
    *,
    Name: str,
    InstanceId: str,
    AssociationStatus: AssociationStatusTypeDef,  # (1)
) -> UpdateAssociationStatusResultTypeDef:  # (2)
    ...

1. See AssociationStatusTypeDef
2. See UpdateAssociationStatusResultTypeDef

# update_association_status method usage example with argument unpacking

kwargs: UpdateAssociationStatusRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InstanceId": ...,
    "AssociationStatus": ...,
}

parent.update_association_status(**kwargs)

1. See UpdateAssociationStatusRequestRequestTypeDef

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

# update_document method definition

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)
    ...

1. See AttachmentsSourceTypeDef
2. See DocumentFormatType
3. See UpdateDocumentResultTypeDef

# update_document method usage example with argument unpacking

kwargs: UpdateDocumentRequestRequestTypeDef = {  # (1)
    "Content": ...,
    "Name": ...,
}

parent.update_document(**kwargs)

1. See UpdateDocumentRequestRequestTypeDef

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

# update_document_default_version method definition

def update_document_default_version(
    self,
    *,
    Name: str,
    DocumentVersion: str,
) -> UpdateDocumentDefaultVersionResultTypeDef:  # (1)
    ...

1. See UpdateDocumentDefaultVersionResultTypeDef

# update_document_default_version method usage example with argument unpacking

kwargs: UpdateDocumentDefaultVersionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "DocumentVersion": ...,
}

parent.update_document_default_version(**kwargs)

1. See UpdateDocumentDefaultVersionRequestRequestTypeDef

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

# update_document_metadata method definition

def update_document_metadata(
    self,
    *,
    Name: str,
    DocumentReviews: DocumentReviewsTypeDef,  # (1)
    DocumentVersion: str = ...,
) -> dict[str, Any]:
    ...

1. See DocumentReviewsTypeDef

# update_document_metadata method usage example with argument unpacking

kwargs: UpdateDocumentMetadataRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "DocumentReviews": ...,
}

parent.update_document_metadata(**kwargs)

1. See UpdateDocumentMetadataRequestRequestTypeDef

update_maintenance_window

Updates an existing maintenance window.

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

# update_maintenance_window method definition

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)
    ...

1. See UpdateMaintenanceWindowResultTypeDef

# update_maintenance_window method usage example with argument unpacking

kwargs: UpdateMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
}

parent.update_maintenance_window(**kwargs)

1. See UpdateMaintenanceWindowRequestRequestTypeDef

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

# update_maintenance_window_target method definition

def update_maintenance_window_target(
    self,
    *,
    WindowId: str,
    WindowTargetId: str,
    Targets: Sequence[TargetTypeDef] = ...,  # (1)
    OwnerInformation: str = ...,
    Name: str = ...,
    Description: str = ...,
    Replace: bool = ...,
) -> UpdateMaintenanceWindowTargetResultTypeDef:  # (2)
    ...

1. See TargetTypeDef
2. See UpdateMaintenanceWindowTargetResultTypeDef

# update_maintenance_window_target method usage example with argument unpacking

kwargs: UpdateMaintenanceWindowTargetRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
    "WindowTargetId": ...,
}

parent.update_maintenance_window_target(**kwargs)

1. See UpdateMaintenanceWindowTargetRequestRequestTypeDef

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

# update_maintenance_window_task method definition

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)
    ...

1. See TargetTypeDef
2. See MaintenanceWindowTaskParameterValueExpressionTypeDef
3. See MaintenanceWindowTaskInvocationParametersTypeDef
4. See LoggingInfoTypeDef
5. See MaintenanceWindowTaskCutoffBehaviorType
6. See AlarmConfigurationTypeDef
7. See UpdateMaintenanceWindowTaskResultTypeDef

# update_maintenance_window_task method usage example with argument unpacking

kwargs: UpdateMaintenanceWindowTaskRequestRequestTypeDef = {  # (1)
    "WindowId": ...,
    "WindowTaskId": ...,
}

parent.update_maintenance_window_task(**kwargs)

1. See UpdateMaintenanceWindowTaskRequestRequestTypeDef

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

# update_managed_instance_role method definition

def update_managed_instance_role(
    self,
    *,
    InstanceId: str,
    IamRole: str,
) -> dict[str, Any]:
    ...

# update_managed_instance_role method usage example with argument unpacking

kwargs: UpdateManagedInstanceRoleRequestRequestTypeDef = {  # (1)
    "InstanceId": ...,
    "IamRole": ...,
}

parent.update_managed_instance_role(**kwargs)

1. See UpdateManagedInstanceRoleRequestRequestTypeDef

update_ops_item

Edit or change an OpsItem.

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

# update_ops_item method definition

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: TimestampTypeDef = ...,
    ActualEndTime: TimestampTypeDef = ...,
    PlannedStartTime: TimestampTypeDef = ...,
    PlannedEndTime: TimestampTypeDef = ...,
    OpsItemArn: str = ...,
) -> dict[str, Any]:
    ...

1. See OpsItemDataValueTypeDef
2. See OpsItemNotificationTypeDef
3. See RelatedOpsItemTypeDef
4. See OpsItemStatusType

# update_ops_item method usage example with argument unpacking

kwargs: UpdateOpsItemRequestRequestTypeDef = {  # (1)
    "OpsItemId": ...,
}

parent.update_ops_item(**kwargs)

1. See UpdateOpsItemRequestRequestTypeDef

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

# update_ops_metadata method definition

def update_ops_metadata(
    self,
    *,
    OpsMetadataArn: str,
    MetadataToUpdate: Mapping[str, MetadataValueTypeDef] = ...,  # (1)
    KeysToDelete: Sequence[str] = ...,
) -> UpdateOpsMetadataResultTypeDef:  # (2)
    ...

1. See MetadataValueTypeDef
2. See UpdateOpsMetadataResultTypeDef

# update_ops_metadata method usage example with argument unpacking

kwargs: UpdateOpsMetadataRequestRequestTypeDef = {  # (1)
    "OpsMetadataArn": ...,
}

parent.update_ops_metadata(**kwargs)

1. See UpdateOpsMetadataRequestRequestTypeDef

update_patch_baseline

Modifies an existing patch baseline.

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

# update_patch_baseline method definition

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)
    ...

1. See PatchFilterGroupTypeDef
2. See PatchRuleGroupTypeDef
3. See PatchComplianceLevelType
4. See PatchActionType
5. See PatchSourceTypeDef
6. See UpdatePatchBaselineResultTypeDef

# update_patch_baseline method usage example with argument unpacking

kwargs: UpdatePatchBaselineRequestRequestTypeDef = {  # (1)
    "BaselineId": ...,
}

parent.update_patch_baseline(**kwargs)

1. See UpdatePatchBaselineRequestRequestTypeDef

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

# update_resource_data_sync method definition

def update_resource_data_sync(
    self,
    *,
    SyncName: str,
    SyncType: str,
    SyncSource: ResourceDataSyncSourceTypeDef,  # (1)
) -> dict[str, Any]:
    ...

1. See ResourceDataSyncSourceTypeDef

# update_resource_data_sync method usage example with argument unpacking

kwargs: UpdateResourceDataSyncRequestRequestTypeDef = {  # (1)
    "SyncName": ...,
    "SyncType": ...,
    "SyncSource": ...,
}

parent.update_resource_data_sync(**kwargs)

1. See UpdateResourceDataSyncRequestRequestTypeDef

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

# update_service_setting method definition

def update_service_setting(
    self,
    *,
    SettingId: str,
    SettingValue: str,
) -> dict[str, Any]:
    ...

# update_service_setting method usage example with argument unpacking

kwargs: UpdateServiceSettingRequestRequestTypeDef = {  # (1)
    "SettingId": ...,
    "SettingValue": ...,
}

parent.update_service_setting(**kwargs)

1. See UpdateServiceSettingRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("ssm").get_paginator method with overloads.

• client.get_paginator("describe_activations") -> DescribeActivationsPaginator
• client.get_paginator("describe_association_execution_targets") -> DescribeAssociationExecutionTargetsPaginator
• client.get_paginator("describe_association_executions") -> DescribeAssociationExecutionsPaginator
• client.get_paginator("describe_automation_executions") -> DescribeAutomationExecutionsPaginator
• client.get_paginator("describe_automation_step_executions") -> DescribeAutomationStepExecutionsPaginator
• client.get_paginator("describe_available_patches") -> DescribeAvailablePatchesPaginator
• client.get_paginator("describe_effective_instance_associations") -> DescribeEffectiveInstanceAssociationsPaginator
• client.get_paginator("describe_effective_patches_for_patch_baseline") -> DescribeEffectivePatchesForPatchBaselinePaginator
• client.get_paginator("describe_instance_associations_status") -> DescribeInstanceAssociationsStatusPaginator
• client.get_paginator("describe_instance_information") -> DescribeInstanceInformationPaginator
• client.get_paginator("describe_instance_patch_states_for_patch_group") -> DescribeInstancePatchStatesForPatchGroupPaginator
• client.get_paginator("describe_instance_patch_states") -> DescribeInstancePatchStatesPaginator
• client.get_paginator("describe_instance_patches") -> DescribeInstancePatchesPaginator
• client.get_paginator("describe_instance_properties") -> DescribeInstancePropertiesPaginator
• client.get_paginator("describe_inventory_deletions") -> DescribeInventoryDeletionsPaginator
• client.get_paginator("describe_maintenance_window_execution_task_invocations") -> DescribeMaintenanceWindowExecutionTaskInvocationsPaginator
• client.get_paginator("describe_maintenance_window_execution_tasks") -> DescribeMaintenanceWindowExecutionTasksPaginator
• client.get_paginator("describe_maintenance_window_executions") -> DescribeMaintenanceWindowExecutionsPaginator
• client.get_paginator("describe_maintenance_window_schedule") -> DescribeMaintenanceWindowSchedulePaginator
• client.get_paginator("describe_maintenance_window_targets") -> DescribeMaintenanceWindowTargetsPaginator
• client.get_paginator("describe_maintenance_window_tasks") -> DescribeMaintenanceWindowTasksPaginator
• client.get_paginator("describe_maintenance_windows_for_target") -> DescribeMaintenanceWindowsForTargetPaginator
• client.get_paginator("describe_maintenance_windows") -> DescribeMaintenanceWindowsPaginator
• client.get_paginator("describe_ops_items") -> DescribeOpsItemsPaginator
• client.get_paginator("describe_parameters") -> DescribeParametersPaginator
• client.get_paginator("describe_patch_baselines") -> DescribePatchBaselinesPaginator
• client.get_paginator("describe_patch_groups") -> DescribePatchGroupsPaginator
• client.get_paginator("describe_patch_properties") -> DescribePatchPropertiesPaginator
• client.get_paginator("describe_sessions") -> DescribeSessionsPaginator
• client.get_paginator("get_inventory") -> GetInventoryPaginator
• client.get_paginator("get_inventory_schema") -> GetInventorySchemaPaginator
• client.get_paginator("get_ops_summary") -> GetOpsSummaryPaginator
• client.get_paginator("get_parameter_history") -> GetParameterHistoryPaginator
• client.get_paginator("get_parameters_by_path") -> GetParametersByPathPaginator
• client.get_paginator("get_resource_policies") -> GetResourcePoliciesPaginator
• client.get_paginator("list_association_versions") -> ListAssociationVersionsPaginator
• client.get_paginator("list_associations") -> ListAssociationsPaginator
• client.get_paginator("list_command_invocations") -> ListCommandInvocationsPaginator
• client.get_paginator("list_commands") -> ListCommandsPaginator
• client.get_paginator("list_compliance_items") -> ListComplianceItemsPaginator
• client.get_paginator("list_compliance_summaries") -> ListComplianceSummariesPaginator
• client.get_paginator("list_document_versions") -> ListDocumentVersionsPaginator
• client.get_paginator("list_documents") -> ListDocumentsPaginator
• client.get_paginator("list_nodes") -> ListNodesPaginator
• client.get_paginator("list_nodes_summary") -> ListNodesSummaryPaginator
• client.get_paginator("list_ops_item_events") -> ListOpsItemEventsPaginator
• client.get_paginator("list_ops_item_related_items") -> ListOpsItemRelatedItemsPaginator
• client.get_paginator("list_ops_metadata") -> ListOpsMetadataPaginator
• client.get_paginator("list_resource_compliance_summaries") -> ListResourceComplianceSummariesPaginator
• client.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