SSMClient
Auto-generated documentation for SSM type annotations stubs module mypy-boto3-ssm.
SSMClient
Type annotations and code completion for boto3.client("ssm")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_ssm.client import SSMClient
def get_ssm_client() -> SSMClient:
return Session().client("ssm")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("ssm").exceptions
structure.
client = boto3.client("ssm")
try:
do_something(client)
except (
client.AlreadyExistsException,
client.AssociatedInstances,
client.AssociationAlreadyExists,
client.AssociationDoesNotExist,
client.AssociationExecutionDoesNotExist,
client.AssociationLimitExceeded,
client.AssociationVersionLimitExceeded,
client.AutomationDefinitionNotApprovedException,
client.AutomationDefinitionNotFoundException,
client.AutomationDefinitionVersionNotFoundException,
client.AutomationExecutionLimitExceededException,
client.AutomationExecutionNotFoundException,
client.AutomationStepNotFoundException,
client.ClientError,
client.ComplianceTypeCountLimitExceededException,
client.CustomSchemaCountLimitExceededException,
client.DocumentAlreadyExists,
client.DocumentLimitExceeded,
client.DocumentPermissionLimit,
client.DocumentVersionLimitExceeded,
client.DoesNotExistException,
client.DuplicateDocumentContent,
client.DuplicateDocumentVersionName,
client.DuplicateInstanceId,
client.FeatureNotAvailableException,
client.HierarchyLevelLimitExceededException,
client.HierarchyTypeMismatchException,
client.IdempotentParameterMismatch,
client.IncompatiblePolicyException,
client.InternalServerError,
client.InvalidActivation,
client.InvalidActivationId,
client.InvalidAggregatorException,
client.InvalidAllowedPatternException,
client.InvalidAssociation,
client.InvalidAssociationVersion,
client.InvalidAutomationExecutionParametersException,
client.InvalidAutomationSignalException,
client.InvalidAutomationStatusUpdateException,
client.InvalidCommandId,
client.InvalidDeleteInventoryParametersException,
client.InvalidDeletionIdException,
client.InvalidDocument,
client.InvalidDocumentContent,
client.InvalidDocumentOperation,
client.InvalidDocumentSchemaVersion,
client.InvalidDocumentType,
client.InvalidDocumentVersion,
client.InvalidFilter,
client.InvalidFilterKey,
client.InvalidFilterOption,
client.InvalidFilterValue,
client.InvalidInstanceId,
client.InvalidInstanceInformationFilterValue,
client.InvalidInventoryGroupException,
client.InvalidInventoryItemContextException,
client.InvalidInventoryRequestException,
client.InvalidItemContentException,
client.InvalidKeyId,
client.InvalidNextToken,
client.InvalidNotificationConfig,
client.InvalidOptionException,
client.InvalidOutputFolder,
client.InvalidOutputLocation,
client.InvalidParameters,
client.InvalidPermissionType,
client.InvalidPluginName,
client.InvalidPolicyAttributeException,
client.InvalidPolicyTypeException,
client.InvalidResourceId,
client.InvalidResourceType,
client.InvalidResultAttributeException,
client.InvalidRole,
client.InvalidSchedule,
client.InvalidTag,
client.InvalidTarget,
client.InvalidTargetMaps,
client.InvalidTypeNameException,
client.InvalidUpdate,
client.InvocationDoesNotExist,
client.ItemContentMismatchException,
client.ItemSizeLimitExceededException,
client.MaxDocumentSizeExceeded,
client.OpsItemAccessDeniedException,
client.OpsItemAlreadyExistsException,
client.OpsItemInvalidParameterException,
client.OpsItemLimitExceededException,
client.OpsItemNotFoundException,
client.OpsItemRelatedItemAlreadyExistsException,
client.OpsItemRelatedItemAssociationNotFoundException,
client.OpsMetadataAlreadyExistsException,
client.OpsMetadataInvalidArgumentException,
client.OpsMetadataKeyLimitExceededException,
client.OpsMetadataLimitExceededException,
client.OpsMetadataNotFoundException,
client.OpsMetadataTooManyUpdatesException,
client.ParameterAlreadyExists,
client.ParameterLimitExceeded,
client.ParameterMaxVersionLimitExceeded,
client.ParameterNotFound,
client.ParameterPatternMismatchException,
client.ParameterVersionLabelLimitExceeded,
client.ParameterVersionNotFound,
client.PoliciesLimitExceededException,
client.ResourceDataSyncAlreadyExistsException,
client.ResourceDataSyncConflictException,
client.ResourceDataSyncCountExceededException,
client.ResourceDataSyncInvalidConfigurationException,
client.ResourceDataSyncNotFoundException,
client.ResourceInUseException,
client.ResourceLimitExceededException,
client.ResourcePolicyConflictException,
client.ResourcePolicyInvalidParameterException,
client.ResourcePolicyLimitExceededException,
client.ServiceSettingNotFound,
client.StatusUnchanged,
client.SubTypeCountLimitExceededException,
client.TargetInUseException,
client.TargetNotConnected,
client.TooManyTagsError,
client.TooManyUpdates,
client.TotalSizeLimitExceededException,
client.UnsupportedCalendarException,
client.UnsupportedFeatureRequiredException,
client.UnsupportedInventoryItemContextException,
client.UnsupportedInventorySchemaVersionException,
client.UnsupportedOperatingSystem,
client.UnsupportedParameterType,
client.UnsupportedPlatformType,
) as e:
print(e)
from mypy_boto3_ssm.client import Exceptions
def handle_error(exc: Exceptions.AlreadyExistsException) -> None:
...
Methods
add_tags_to_resource
Adds or overwrites one or more tags for the specified resource.
Type annotations and code completion for boto3.client("ssm").add_tags_to_resource
method.
boto3 documentation
def add_tags_to_resource(
self,
*,
ResourceType: ResourceTypeForTaggingType, # (1)
ResourceId: str,
Tags: Sequence[TagTypeDef], # (2)
) -> Dict[str, Any]:
...
- See ResourceTypeForTaggingType
- See TagTypeDef
kwargs: AddTagsToResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
"ResourceId": ...,
"Tags": ...,
}
parent.add_tags_to_resource(**kwargs)
associate_ops_item_related_item
Associates a related item to a Systems Manager OpsCenter OpsItem.
Type annotations and code completion for boto3.client("ssm").associate_ops_item_related_item
method.
boto3 documentation
def associate_ops_item_related_item(
self,
*,
OpsItemId: str,
AssociationType: str,
ResourceType: str,
ResourceUri: str,
) -> AssociateOpsItemRelatedItemResponseTypeDef: # (1)
...
kwargs: AssociateOpsItemRelatedItemRequestRequestTypeDef = { # (1)
"OpsItemId": ...,
"AssociationType": ...,
"ResourceType": ...,
"ResourceUri": ...,
}
parent.associate_ops_item_related_item(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("ssm").can_paginate
method.
boto3 documentation
cancel_command
Attempts to cancel the command specified by the Command ID.
Type annotations and code completion for boto3.client("ssm").cancel_command
method.
boto3 documentation
def cancel_command(
self,
*,
CommandId: str,
InstanceIds: Sequence[str] = ...,
) -> Dict[str, Any]:
...
kwargs: CancelCommandRequestRequestTypeDef = { # (1)
"CommandId": ...,
}
parent.cancel_command(**kwargs)
cancel_maintenance_window_execution
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running.
Type annotations and code completion for boto3.client("ssm").cancel_maintenance_window_execution
method.
boto3 documentation
def cancel_maintenance_window_execution(
self,
*,
WindowExecutionId: str,
) -> CancelMaintenanceWindowExecutionResultTypeDef: # (1)
...
kwargs: CancelMaintenanceWindowExecutionRequestRequestTypeDef = { # (1)
"WindowExecutionId": ...,
}
parent.cancel_maintenance_window_execution(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("ssm").close
method.
boto3 documentation
create_activation
Generates an activation code and activation ID you can use to register your on- premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.
Type annotations and code completion for boto3.client("ssm").create_activation
method.
boto3 documentation
def create_activation(
self,
*,
IamRole: str,
Description: str = ...,
DefaultInstanceName: str = ...,
RegistrationLimit: int = ...,
ExpirationDate: Union[datetime, str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
RegistrationMetadata: Sequence[RegistrationMetadataItemTypeDef] = ..., # (2)
) -> CreateActivationResultTypeDef: # (3)
...
kwargs: CreateActivationRequestRequestTypeDef = { # (1)
"IamRole": ...,
}
parent.create_activation(**kwargs)
create_association
A State Manager association defines the state that you want to maintain on your managed nodes.
Type annotations and code completion for boto3.client("ssm").create_association
method.
boto3 documentation
def create_association(
self,
*,
Name: str,
DocumentVersion: str = ...,
InstanceId: str = ...,
Parameters: Mapping[str, Sequence[str]] = ...,
Targets: Sequence[TargetTypeDef] = ..., # (1)
ScheduleExpression: str = ...,
OutputLocation: InstanceAssociationOutputLocationTypeDef = ..., # (2)
AssociationName: str = ...,
AutomationTargetParameterName: str = ...,
MaxErrors: str = ...,
MaxConcurrency: str = ...,
ComplianceSeverity: AssociationComplianceSeverityType = ..., # (3)
SyncCompliance: AssociationSyncComplianceType = ..., # (4)
ApplyOnlyAtCronInterval: bool = ...,
CalendarNames: Sequence[str] = ...,
TargetLocations: Sequence[TargetLocationTypeDef] = ..., # (5)
ScheduleOffset: int = ...,
TargetMaps: Sequence[Mapping[str, Sequence[str]]] = ...,
Tags: Sequence[TagTypeDef] = ..., # (6)
AlarmConfiguration: AlarmConfigurationTypeDef = ..., # (7)
) -> CreateAssociationResultTypeDef: # (8)
...
- See TargetTypeDef
- See InstanceAssociationOutputLocationTypeDef
- See AssociationComplianceSeverityType
- See AssociationSyncComplianceType
- See TargetLocationTypeDef
- See TagTypeDef
- See AlarmConfigurationTypeDef
- See CreateAssociationResultTypeDef
kwargs: CreateAssociationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_association(**kwargs)
create_association_batch
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
Type annotations and code completion for boto3.client("ssm").create_association_batch
method.
boto3 documentation
def create_association_batch(
self,
*,
Entries: Sequence[CreateAssociationBatchRequestEntryTypeDef], # (1)
) -> CreateAssociationBatchResultTypeDef: # (2)
...
kwargs: CreateAssociationBatchRequestRequestTypeDef = { # (1)
"Entries": ...,
}
parent.create_association_batch(**kwargs)
create_document
Creates a Amazon Web Services Systems Manager (SSM document).
Type annotations and code completion for boto3.client("ssm").create_document
method.
boto3 documentation
def create_document(
self,
*,
Content: str,
Name: str,
Requires: Sequence[DocumentRequiresTypeDef] = ..., # (1)
Attachments: Sequence[AttachmentsSourceTypeDef] = ..., # (2)
DisplayName: str = ...,
VersionName: str = ...,
DocumentType: DocumentTypeType = ..., # (3)
DocumentFormat: DocumentFormatType = ..., # (4)
TargetType: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (5)
) -> CreateDocumentResultTypeDef: # (6)
...
- See DocumentRequiresTypeDef
- See AttachmentsSourceTypeDef
- See DocumentTypeType
- See DocumentFormatType
- See TagTypeDef
- See CreateDocumentResultTypeDef
kwargs: CreateDocumentRequestRequestTypeDef = { # (1)
"Content": ...,
"Name": ...,
}
parent.create_document(**kwargs)
create_maintenance_window
Creates a new maintenance window.
Type annotations and code completion for boto3.client("ssm").create_maintenance_window
method.
boto3 documentation
def create_maintenance_window(
self,
*,
Name: str,
Schedule: str,
Duration: int,
Cutoff: int,
AllowUnassociatedTargets: bool,
Description: str = ...,
StartDate: str = ...,
EndDate: str = ...,
ScheduleTimezone: str = ...,
ScheduleOffset: int = ...,
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateMaintenanceWindowResultTypeDef: # (2)
...
kwargs: CreateMaintenanceWindowRequestRequestTypeDef = { # (1)
"Name": ...,
"Schedule": ...,
"Duration": ...,
"Cutoff": ...,
"AllowUnassociatedTargets": ...,
}
parent.create_maintenance_window(**kwargs)
create_ops_item
Creates a new OpsItem.
Type annotations and code completion for boto3.client("ssm").create_ops_item
method.
boto3 documentation
def create_ops_item(
self,
*,
Description: str,
Source: str,
Title: str,
OpsItemType: str = ...,
OperationalData: Mapping[str, OpsItemDataValueTypeDef] = ..., # (1)
Notifications: Sequence[OpsItemNotificationTypeDef] = ..., # (2)
Priority: int = ...,
RelatedOpsItems: Sequence[RelatedOpsItemTypeDef] = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
Category: str = ...,
Severity: str = ...,
ActualStartTime: Union[datetime, str] = ...,
ActualEndTime: Union[datetime, str] = ...,
PlannedStartTime: Union[datetime, str] = ...,
PlannedEndTime: Union[datetime, str] = ...,
AccountId: str = ...,
) -> CreateOpsItemResponseTypeDef: # (5)
...
- See OpsItemDataValueTypeDef
- See OpsItemNotificationTypeDef
- See RelatedOpsItemTypeDef
- See TagTypeDef
- See CreateOpsItemResponseTypeDef
kwargs: CreateOpsItemRequestRequestTypeDef = { # (1)
"Description": ...,
"Source": ...,
"Title": ...,
}
parent.create_ops_item(**kwargs)
create_ops_metadata
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
Type annotations and code completion for boto3.client("ssm").create_ops_metadata
method.
boto3 documentation
def create_ops_metadata(
self,
*,
ResourceId: str,
Metadata: Mapping[str, MetadataValueTypeDef] = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateOpsMetadataResultTypeDef: # (3)
...
kwargs: CreateOpsMetadataRequestRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.create_ops_metadata(**kwargs)
create_patch_baseline
Creates a patch baseline.
Type annotations and code completion for boto3.client("ssm").create_patch_baseline
method.
boto3 documentation
def create_patch_baseline(
self,
*,
Name: str,
OperatingSystem: OperatingSystemType = ..., # (1)
GlobalFilters: PatchFilterGroupTypeDef = ..., # (2)
ApprovalRules: PatchRuleGroupTypeDef = ..., # (3)
ApprovedPatches: Sequence[str] = ...,
ApprovedPatchesComplianceLevel: PatchComplianceLevelType = ..., # (4)
ApprovedPatchesEnableNonSecurity: bool = ...,
RejectedPatches: Sequence[str] = ...,
RejectedPatchesAction: PatchActionType = ..., # (5)
Description: str = ...,
Sources: Sequence[PatchSourceTypeDef] = ..., # (6)
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (7)
) -> CreatePatchBaselineResultTypeDef: # (8)
...
- See OperatingSystemType
- See PatchFilterGroupTypeDef
- See PatchRuleGroupTypeDef
- See PatchComplianceLevelType
- See PatchActionType
- See PatchSourceTypeDef
- See TagTypeDef
- See CreatePatchBaselineResultTypeDef
kwargs: CreatePatchBaselineRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_patch_baseline(**kwargs)
create_resource_data_sync
A resource data sync helps you view data from multiple sources in a single location.
Type annotations and code completion for boto3.client("ssm").create_resource_data_sync
method.
boto3 documentation
def create_resource_data_sync(
self,
*,
SyncName: str,
S3Destination: ResourceDataSyncS3DestinationTypeDef = ..., # (1)
SyncType: str = ...,
SyncSource: ResourceDataSyncSourceTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
kwargs: CreateResourceDataSyncRequestRequestTypeDef = { # (1)
"SyncName": ...,
}
parent.create_resource_data_sync(**kwargs)
delete_activation
Deletes an activation.
Type annotations and code completion for boto3.client("ssm").delete_activation
method.
boto3 documentation
kwargs: DeleteActivationRequestRequestTypeDef = { # (1)
"ActivationId": ...,
}
parent.delete_activation(**kwargs)
delete_association
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
Type annotations and code completion for boto3.client("ssm").delete_association
method.
boto3 documentation
def delete_association(
self,
*,
Name: str = ...,
InstanceId: str = ...,
AssociationId: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteAssociationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_association(**kwargs)
delete_document
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Type annotations and code completion for boto3.client("ssm").delete_document
method.
boto3 documentation
def delete_document(
self,
*,
Name: str,
DocumentVersion: str = ...,
VersionName: str = ...,
Force: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteDocumentRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_document(**kwargs)
delete_inventory
Delete a custom inventory type or the data associated with a custom Inventory type.
Type annotations and code completion for boto3.client("ssm").delete_inventory
method.
boto3 documentation
def delete_inventory(
self,
*,
TypeName: str,
SchemaDeleteOption: InventorySchemaDeleteOptionType = ..., # (1)
DryRun: bool = ...,
ClientToken: str = ...,
) -> DeleteInventoryResultTypeDef: # (2)
...
kwargs: DeleteInventoryRequestRequestTypeDef = { # (1)
"TypeName": ...,
}
parent.delete_inventory(**kwargs)
delete_maintenance_window
Deletes a maintenance window.
Type annotations and code completion for boto3.client("ssm").delete_maintenance_window
method.
boto3 documentation
def delete_maintenance_window(
self,
*,
WindowId: str,
) -> DeleteMaintenanceWindowResultTypeDef: # (1)
...
kwargs: DeleteMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
}
parent.delete_maintenance_window(**kwargs)
delete_ops_metadata
Delete OpsMetadata related to an application.
Type annotations and code completion for boto3.client("ssm").delete_ops_metadata
method.
boto3 documentation
kwargs: DeleteOpsMetadataRequestRequestTypeDef = { # (1)
"OpsMetadataArn": ...,
}
parent.delete_ops_metadata(**kwargs)
delete_parameter
Delete a parameter from the system.
Type annotations and code completion for boto3.client("ssm").delete_parameter
method.
boto3 documentation
kwargs: DeleteParameterRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_parameter(**kwargs)
delete_parameters
Delete a list of parameters.
Type annotations and code completion for boto3.client("ssm").delete_parameters
method.
boto3 documentation
def delete_parameters(
self,
*,
Names: Sequence[str],
) -> DeleteParametersResultTypeDef: # (1)
...
kwargs: DeleteParametersRequestRequestTypeDef = { # (1)
"Names": ...,
}
parent.delete_parameters(**kwargs)
delete_patch_baseline
Deletes a patch baseline.
Type annotations and code completion for boto3.client("ssm").delete_patch_baseline
method.
boto3 documentation
def delete_patch_baseline(
self,
*,
BaselineId: str,
) -> DeletePatchBaselineResultTypeDef: # (1)
...
kwargs: DeletePatchBaselineRequestRequestTypeDef = { # (1)
"BaselineId": ...,
}
parent.delete_patch_baseline(**kwargs)
delete_resource_data_sync
Deletes a resource data sync configuration.
Type annotations and code completion for boto3.client("ssm").delete_resource_data_sync
method.
boto3 documentation
def delete_resource_data_sync(
self,
*,
SyncName: str,
SyncType: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteResourceDataSyncRequestRequestTypeDef = { # (1)
"SyncName": ...,
}
parent.delete_resource_data_sync(**kwargs)
delete_resource_policy
Deletes a Systems Manager resource policy.
Type annotations and code completion for boto3.client("ssm").delete_resource_policy
method.
boto3 documentation
def delete_resource_policy(
self,
*,
ResourceArn: str,
PolicyId: str,
PolicyHash: str,
) -> Dict[str, Any]:
...
kwargs: DeleteResourcePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"PolicyId": ...,
"PolicyHash": ...,
}
parent.delete_resource_policy(**kwargs)
deregister_managed_instance
Removes the server or virtual machine from the list of registered servers.
Type annotations and code completion for boto3.client("ssm").deregister_managed_instance
method.
boto3 documentation
def deregister_managed_instance(
self,
*,
InstanceId: str,
) -> Dict[str, Any]:
...
kwargs: DeregisterManagedInstanceRequestRequestTypeDef = { # (1)
"InstanceId": ...,
}
parent.deregister_managed_instance(**kwargs)
deregister_patch_baseline_for_patch_group
Removes a patch group from a patch baseline.
Type annotations and code completion for boto3.client("ssm").deregister_patch_baseline_for_patch_group
method.
boto3 documentation
def deregister_patch_baseline_for_patch_group(
self,
*,
BaselineId: str,
PatchGroup: str,
) -> DeregisterPatchBaselineForPatchGroupResultTypeDef: # (1)
...
kwargs: DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef = { # (1)
"BaselineId": ...,
"PatchGroup": ...,
}
parent.deregister_patch_baseline_for_patch_group(**kwargs)
deregister_target_from_maintenance_window
Removes a target from a maintenance window.
Type annotations and code completion for boto3.client("ssm").deregister_target_from_maintenance_window
method.
boto3 documentation
def deregister_target_from_maintenance_window(
self,
*,
WindowId: str,
WindowTargetId: str,
Safe: bool = ...,
) -> DeregisterTargetFromMaintenanceWindowResultTypeDef: # (1)
...
kwargs: DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
"WindowTargetId": ...,
}
parent.deregister_target_from_maintenance_window(**kwargs)
deregister_task_from_maintenance_window
Removes a task from a maintenance window.
Type annotations and code completion for boto3.client("ssm").deregister_task_from_maintenance_window
method.
boto3 documentation
def deregister_task_from_maintenance_window(
self,
*,
WindowId: str,
WindowTaskId: str,
) -> DeregisterTaskFromMaintenanceWindowResultTypeDef: # (1)
...
kwargs: DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef = { # (1)
"WindowId": ...,
"WindowTaskId": ...,
}
parent.deregister_task_from_maintenance_window(**kwargs)
describe_activations
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
Type annotations and code completion for boto3.client("ssm").describe_activations
method.
boto3 documentation
def describe_activations(
self,
*,
Filters: Sequence[DescribeActivationsFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeActivationsResultTypeDef: # (2)
...
kwargs: DescribeActivationsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_activations(**kwargs)
describe_association
Describes the association for the specified target or managed node.
Type annotations and code completion for boto3.client("ssm").describe_association
method.
boto3 documentation
def describe_association(
self,
*,
Name: str = ...,
InstanceId: str = ...,
AssociationId: str = ...,
AssociationVersion: str = ...,
) -> DescribeAssociationResultTypeDef: # (1)
...
kwargs: DescribeAssociationRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.describe_association(**kwargs)
describe_association_execution_targets
Views information about a specific execution of a specific association.
Type annotations and code completion for boto3.client("ssm").describe_association_execution_targets
method.
boto3 documentation
def describe_association_execution_targets(
self,
*,
AssociationId: str,
ExecutionId: str,
Filters: Sequence[AssociationExecutionTargetsFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAssociationExecutionTargetsResultTypeDef: # (2)
...
kwargs: DescribeAssociationExecutionTargetsRequestRequestTypeDef = { # (1)
"AssociationId": ...,
"ExecutionId": ...,
}
parent.describe_association_execution_targets(**kwargs)
describe_association_executions
Views all executions for a specific association ID.
Type annotations and code completion for boto3.client("ssm").describe_association_executions
method.
boto3 documentation
def describe_association_executions(
self,
*,
AssociationId: str,
Filters: Sequence[AssociationExecutionFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAssociationExecutionsResultTypeDef: # (2)
...
kwargs: DescribeAssociationExecutionsRequestRequestTypeDef = { # (1)
"AssociationId": ...,
}
parent.describe_association_executions(**kwargs)
describe_automation_executions
Provides details about all active and terminated Automation executions.
Type annotations and code completion for boto3.client("ssm").describe_automation_executions
method.
boto3 documentation
def describe_automation_executions(
self,
*,
Filters: Sequence[AutomationExecutionFilterTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeAutomationExecutionsResultTypeDef: # (2)
...
kwargs: DescribeAutomationExecutionsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_automation_executions(**kwargs)
describe_automation_step_executions
Information about all active and terminated step executions in an Automation workflow.
Type annotations and code completion for boto3<