Skip to content

Typed dictionaries

Index > SSM > Typed dictionaries

Auto-generated documentation for SSM type annotations stubs module mypy-boto3-ssm.

AccountSharingInfoTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AccountSharingInfoTypeDef

def get_value() -> AccountSharingInfoTypeDef:
    return {
        "AccountId": ...,
    }
Definition
class AccountSharingInfoTypeDef(TypedDict):
    AccountId: NotRequired[str],
    SharedDocumentVersion: NotRequired[str],

TagTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

AlarmTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AlarmTypeDef

def get_value() -> AlarmTypeDef:
    return {
        "Name": ...,
    }
Definition
class AlarmTypeDef(TypedDict):
    Name: str,

AlarmStateInformationTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AlarmStateInformationTypeDef

def get_value() -> AlarmStateInformationTypeDef:
    return {
        "Name": ...,
        "State": ...,
    }
Definition
class AlarmStateInformationTypeDef(TypedDict):
    Name: str,
    State: ExternalAlarmStateType,  # (1)
  1. See ExternalAlarmStateType

AssociateOpsItemRelatedItemRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AssociateOpsItemRelatedItemRequestRequestTypeDef

def get_value() -> AssociateOpsItemRelatedItemRequestRequestTypeDef:
    return {
        "OpsItemId": ...,
        "AssociationType": ...,
        "ResourceType": ...,
        "ResourceUri": ...,
    }
Definition
class AssociateOpsItemRelatedItemRequestRequestTypeDef(TypedDict):
    OpsItemId: str,
    AssociationType: str,
    ResourceType: str,
    ResourceUri: str,

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AssociationOverviewTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AssociationOverviewTypeDef

def get_value() -> AssociationOverviewTypeDef:
    return {
        "Status": ...,
    }
Definition
class AssociationOverviewTypeDef(TypedDict):
    Status: NotRequired[str],
    DetailedStatus: NotRequired[str],
    AssociationStatusAggregatedCount: NotRequired[Dict[str, int]],

AssociationStatusTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AssociationStatusTypeDef

def get_value() -> AssociationStatusTypeDef:
    return {
        "Date": ...,
        "Name": ...,
        "Message": ...,
    }
Definition
class AssociationStatusTypeDef(TypedDict):
    Date: datetime,
    Name: AssociationStatusNameType,  # (1)
    Message: str,
    AdditionalInfo: NotRequired[str],
  1. See AssociationStatusNameType

TargetLocationTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import TargetLocationTypeDef

def get_value() -> TargetLocationTypeDef:
    return {
        "Accounts": ...,
    }
Definition
class TargetLocationTypeDef(TypedDict):
    Accounts: NotRequired[Sequence[str]],
    Regions: NotRequired[Sequence[str]],
    TargetLocationMaxConcurrency: NotRequired[str],
    TargetLocationMaxErrors: NotRequired[str],
    ExecutionRoleName: NotRequired[str],

TargetTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import TargetTypeDef

def get_value() -> TargetTypeDef:
    return {
        "Key": ...,
    }
Definition
class TargetTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],

AssociationExecutionFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AssociationExecutionFilterTypeDef

def get_value() -> AssociationExecutionFilterTypeDef:
    return {
        "Key": ...,
        "Value": ...,
        "Type": ...,
    }
Definition
class AssociationExecutionFilterTypeDef(TypedDict):
    Key: AssociationExecutionFilterKeyType,  # (1)
    Value: str,
    Type: AssociationFilterOperatorTypeType,  # (2)
  1. See AssociationExecutionFilterKeyType
  2. See AssociationFilterOperatorTypeType

OutputSourceTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import OutputSourceTypeDef

def get_value() -> OutputSourceTypeDef:
    return {
        "OutputSourceId": ...,
    }
Definition
class OutputSourceTypeDef(TypedDict):
    OutputSourceId: NotRequired[str],
    OutputSourceType: NotRequired[str],

AssociationExecutionTargetsFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AssociationExecutionTargetsFilterTypeDef

def get_value() -> AssociationExecutionTargetsFilterTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class AssociationExecutionTargetsFilterTypeDef(TypedDict):
    Key: AssociationExecutionTargetsFilterKeyType,  # (1)
    Value: str,
  1. See AssociationExecutionTargetsFilterKeyType

AssociationFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AssociationFilterTypeDef

def get_value() -> AssociationFilterTypeDef:
    return {
        "key": ...,
        "value": ...,
    }
Definition
class AssociationFilterTypeDef(TypedDict):
    key: AssociationFilterKeyType,  # (1)
    value: str,
  1. See AssociationFilterKeyType

AttachmentContentTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AttachmentContentTypeDef

def get_value() -> AttachmentContentTypeDef:
    return {
        "Name": ...,
    }
Definition
class AttachmentContentTypeDef(TypedDict):
    Name: NotRequired[str],
    Size: NotRequired[int],
    Hash: NotRequired[str],
    HashType: NotRequired[AttachmentHashTypeType],  # (1)
    Url: NotRequired[str],
  1. See AttachmentHashTypeType

AttachmentInformationTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AttachmentInformationTypeDef

def get_value() -> AttachmentInformationTypeDef:
    return {
        "Name": ...,
    }
Definition
class AttachmentInformationTypeDef(TypedDict):
    Name: NotRequired[str],

AttachmentsSourceTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AttachmentsSourceTypeDef

def get_value() -> AttachmentsSourceTypeDef:
    return {
        "Key": ...,
    }
Definition
class AttachmentsSourceTypeDef(TypedDict):
    Key: NotRequired[AttachmentsSourceKeyType],  # (1)
    Values: NotRequired[Sequence[str]],
    Name: NotRequired[str],
  1. See AttachmentsSourceKeyType

AutomationExecutionFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import AutomationExecutionFilterTypeDef

def get_value() -> AutomationExecutionFilterTypeDef:
    return {
        "Key": ...,
        "Values": ...,
    }
Definition
class AutomationExecutionFilterTypeDef(TypedDict):
    Key: AutomationExecutionFilterKeyType,  # (1)
    Values: Sequence[str],
  1. See AutomationExecutionFilterKeyType

ResolvedTargetsTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ResolvedTargetsTypeDef

def get_value() -> ResolvedTargetsTypeDef:
    return {
        "ParameterValues": ...,
    }
Definition
class ResolvedTargetsTypeDef(TypedDict):
    ParameterValues: NotRequired[List[str]],
    Truncated: NotRequired[bool],

ProgressCountersTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ProgressCountersTypeDef

def get_value() -> ProgressCountersTypeDef:
    return {
        "TotalSteps": ...,
    }
Definition
class ProgressCountersTypeDef(TypedDict):
    TotalSteps: NotRequired[int],
    SuccessSteps: NotRequired[int],
    FailedSteps: NotRequired[int],
    CancelledSteps: NotRequired[int],
    TimedOutSteps: NotRequired[int],

PatchSourceTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import PatchSourceTypeDef

def get_value() -> PatchSourceTypeDef:
    return {
        "Name": ...,
        "Products": ...,
        "Configuration": ...,
    }
Definition
class PatchSourceTypeDef(TypedDict):
    Name: str,
    Products: Sequence[str],
    Configuration: str,

CancelCommandRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import CancelCommandRequestRequestTypeDef

def get_value() -> CancelCommandRequestRequestTypeDef:
    return {
        "CommandId": ...,
    }
Definition
class CancelCommandRequestRequestTypeDef(TypedDict):
    CommandId: str,
    InstanceIds: NotRequired[Sequence[str]],

CancelMaintenanceWindowExecutionRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import CancelMaintenanceWindowExecutionRequestRequestTypeDef

def get_value() -> CancelMaintenanceWindowExecutionRequestRequestTypeDef:
    return {
        "WindowExecutionId": ...,
    }
Definition
class CancelMaintenanceWindowExecutionRequestRequestTypeDef(TypedDict):
    WindowExecutionId: str,

CloudWatchOutputConfigTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import CloudWatchOutputConfigTypeDef

def get_value() -> CloudWatchOutputConfigTypeDef:
    return {
        "CloudWatchLogGroupName": ...,
    }
Definition
class CloudWatchOutputConfigTypeDef(TypedDict):
    CloudWatchLogGroupName: NotRequired[str],
    CloudWatchOutputEnabled: NotRequired[bool],

CommandFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import CommandFilterTypeDef

def get_value() -> CommandFilterTypeDef:
    return {
        "key": ...,
        "value": ...,
    }
Definition
class CommandFilterTypeDef(TypedDict):
    key: CommandFilterKeyType,  # (1)
    value: str,
  1. See CommandFilterKeyType

CommandPluginTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import CommandPluginTypeDef

def get_value() -> CommandPluginTypeDef:
    return {
        "Name": ...,
    }
Definition
class CommandPluginTypeDef(TypedDict):
    Name: NotRequired[str],
    Status: NotRequired[CommandPluginStatusType],  # (1)
    StatusDetails: NotRequired[str],
    ResponseCode: NotRequired[int],
    ResponseStartDateTime: NotRequired[datetime],
    ResponseFinishDateTime: NotRequired[datetime],
    Output: NotRequired[str],
    StandardOutputUrl: NotRequired[str],
    StandardErrorUrl: NotRequired[str],
    OutputS3Region: NotRequired[str],
    OutputS3BucketName: NotRequired[str],
    OutputS3KeyPrefix: NotRequired[str],
  1. See CommandPluginStatusType

NotificationConfigTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import NotificationConfigTypeDef

def get_value() -> NotificationConfigTypeDef:
    return {
        "NotificationArn": ...,
    }
Definition
class NotificationConfigTypeDef(TypedDict):
    NotificationArn: NotRequired[str],
    NotificationEvents: NotRequired[List[NotificationEventType]],  # (1)
    NotificationType: NotRequired[NotificationTypeType],  # (2)
  1. See NotificationEventType
  2. See NotificationTypeType

ComplianceExecutionSummaryTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ComplianceExecutionSummaryTypeDef

def get_value() -> ComplianceExecutionSummaryTypeDef:
    return {
        "ExecutionTime": ...,
    }
Definition
class ComplianceExecutionSummaryTypeDef(TypedDict):
    ExecutionTime: datetime,
    ExecutionId: NotRequired[str],
    ExecutionType: NotRequired[str],

ComplianceItemEntryTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ComplianceItemEntryTypeDef

def get_value() -> ComplianceItemEntryTypeDef:
    return {
        "Severity": ...,
        "Status": ...,
    }
Definition
class ComplianceItemEntryTypeDef(TypedDict):
    Severity: ComplianceSeverityType,  # (1)
    Status: ComplianceStatusType,  # (2)
    Id: NotRequired[str],
    Title: NotRequired[str],
    Details: NotRequired[Mapping[str, str]],
  1. See ComplianceSeverityType
  2. See ComplianceStatusType

ComplianceStringFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ComplianceStringFilterTypeDef

def get_value() -> ComplianceStringFilterTypeDef:
    return {
        "Key": ...,
    }
Definition
class ComplianceStringFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],
    Type: NotRequired[ComplianceQueryOperatorTypeType],  # (1)
  1. See ComplianceQueryOperatorTypeType

SeveritySummaryTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import SeveritySummaryTypeDef

def get_value() -> SeveritySummaryTypeDef:
    return {
        "CriticalCount": ...,
    }
Definition
class SeveritySummaryTypeDef(TypedDict):
    CriticalCount: NotRequired[int],
    HighCount: NotRequired[int],
    MediumCount: NotRequired[int],
    LowCount: NotRequired[int],
    InformationalCount: NotRequired[int],
    UnspecifiedCount: NotRequired[int],

RegistrationMetadataItemTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import RegistrationMetadataItemTypeDef

def get_value() -> RegistrationMetadataItemTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
Definition
class RegistrationMetadataItemTypeDef(TypedDict):
    Key: str,
    Value: str,

DocumentRequiresTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DocumentRequiresTypeDef

def get_value() -> DocumentRequiresTypeDef:
    return {
        "Name": ...,
    }
Definition
class DocumentRequiresTypeDef(TypedDict):
    Name: str,
    Version: NotRequired[str],

OpsItemDataValueTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import OpsItemDataValueTypeDef

def get_value() -> OpsItemDataValueTypeDef:
    return {
        "Value": ...,
    }
Definition
class OpsItemDataValueTypeDef(TypedDict):
    Value: NotRequired[str],
    Type: NotRequired[OpsItemDataTypeType],  # (1)
  1. See OpsItemDataTypeType

OpsItemNotificationTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import OpsItemNotificationTypeDef

def get_value() -> OpsItemNotificationTypeDef:
    return {
        "Arn": ...,
    }
Definition
class OpsItemNotificationTypeDef(TypedDict):
    Arn: NotRequired[str],

RelatedOpsItemTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import RelatedOpsItemTypeDef

def get_value() -> RelatedOpsItemTypeDef:
    return {
        "OpsItemId": ...,
    }
Definition
class RelatedOpsItemTypeDef(TypedDict):
    OpsItemId: str,

MetadataValueTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import MetadataValueTypeDef

def get_value() -> MetadataValueTypeDef:
    return {
        "Value": ...,
    }
Definition
class MetadataValueTypeDef(TypedDict):
    Value: NotRequired[str],

DeleteActivationRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteActivationRequestRequestTypeDef

def get_value() -> DeleteActivationRequestRequestTypeDef:
    return {
        "ActivationId": ...,
    }
Definition
class DeleteActivationRequestRequestTypeDef(TypedDict):
    ActivationId: str,

DeleteAssociationRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteAssociationRequestRequestTypeDef

def get_value() -> DeleteAssociationRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DeleteAssociationRequestRequestTypeDef(TypedDict):
    Name: NotRequired[str],
    InstanceId: NotRequired[str],
    AssociationId: NotRequired[str],

DeleteDocumentRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteDocumentRequestRequestTypeDef

def get_value() -> DeleteDocumentRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DeleteDocumentRequestRequestTypeDef(TypedDict):
    Name: str,
    DocumentVersion: NotRequired[str],
    VersionName: NotRequired[str],
    Force: NotRequired[bool],

DeleteInventoryRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteInventoryRequestRequestTypeDef

def get_value() -> DeleteInventoryRequestRequestTypeDef:
    return {
        "TypeName": ...,
    }
Definition
class DeleteInventoryRequestRequestTypeDef(TypedDict):
    TypeName: str,
    SchemaDeleteOption: NotRequired[InventorySchemaDeleteOptionType],  # (1)
    DryRun: NotRequired[bool],
    ClientToken: NotRequired[str],
  1. See InventorySchemaDeleteOptionType

DeleteMaintenanceWindowRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteMaintenanceWindowRequestRequestTypeDef

def get_value() -> DeleteMaintenanceWindowRequestRequestTypeDef:
    return {
        "WindowId": ...,
    }
Definition
class DeleteMaintenanceWindowRequestRequestTypeDef(TypedDict):
    WindowId: str,

DeleteOpsMetadataRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteOpsMetadataRequestRequestTypeDef

def get_value() -> DeleteOpsMetadataRequestRequestTypeDef:
    return {
        "OpsMetadataArn": ...,
    }
Definition
class DeleteOpsMetadataRequestRequestTypeDef(TypedDict):
    OpsMetadataArn: str,

DeleteParameterRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteParameterRequestRequestTypeDef

def get_value() -> DeleteParameterRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DeleteParameterRequestRequestTypeDef(TypedDict):
    Name: str,

DeleteParametersRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteParametersRequestRequestTypeDef

def get_value() -> DeleteParametersRequestRequestTypeDef:
    return {
        "Names": ...,
    }
Definition
class DeleteParametersRequestRequestTypeDef(TypedDict):
    Names: Sequence[str],

DeletePatchBaselineRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeletePatchBaselineRequestRequestTypeDef

def get_value() -> DeletePatchBaselineRequestRequestTypeDef:
    return {
        "BaselineId": ...,
    }
Definition
class DeletePatchBaselineRequestRequestTypeDef(TypedDict):
    BaselineId: str,

DeleteResourceDataSyncRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeleteResourceDataSyncRequestRequestTypeDef

def get_value() -> DeleteResourceDataSyncRequestRequestTypeDef:
    return {
        "SyncName": ...,
    }
Definition
class DeleteResourceDataSyncRequestRequestTypeDef(TypedDict):
    SyncName: str,
    SyncType: NotRequired[str],

DeregisterManagedInstanceRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeregisterManagedInstanceRequestRequestTypeDef

def get_value() -> DeregisterManagedInstanceRequestRequestTypeDef:
    return {
        "InstanceId": ...,
    }
Definition
class DeregisterManagedInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,

DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef

def get_value() -> DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef:
    return {
        "BaselineId": ...,
        "PatchGroup": ...,
    }
Definition
class DeregisterPatchBaselineForPatchGroupRequestRequestTypeDef(TypedDict):
    BaselineId: str,
    PatchGroup: str,

DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef

def get_value() -> DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef:
    return {
        "WindowId": ...,
        "WindowTargetId": ...,
    }
Definition
class DeregisterTargetFromMaintenanceWindowRequestRequestTypeDef(TypedDict):
    WindowId: str,
    WindowTargetId: str,
    Safe: NotRequired[bool],

DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef

def get_value() -> DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef:
    return {
        "WindowId": ...,
        "WindowTaskId": ...,
    }
Definition
class DeregisterTaskFromMaintenanceWindowRequestRequestTypeDef(TypedDict):
    WindowId: str,
    WindowTaskId: str,

DescribeActivationsFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeActivationsFilterTypeDef

def get_value() -> DescribeActivationsFilterTypeDef:
    return {
        "FilterKey": ...,
    }
Definition
class DescribeActivationsFilterTypeDef(TypedDict):
    FilterKey: NotRequired[DescribeActivationsFilterKeysType],  # (1)
    FilterValues: NotRequired[Sequence[str]],
  1. See DescribeActivationsFilterKeysType

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeAssociationRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeAssociationRequestRequestTypeDef

def get_value() -> DescribeAssociationRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DescribeAssociationRequestRequestTypeDef(TypedDict):
    Name: NotRequired[str],
    InstanceId: NotRequired[str],
    AssociationId: NotRequired[str],
    AssociationVersion: NotRequired[str],

StepExecutionFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import StepExecutionFilterTypeDef

def get_value() -> StepExecutionFilterTypeDef:
    return {
        "Key": ...,
        "Values": ...,
    }
Definition
class StepExecutionFilterTypeDef(TypedDict):
    Key: StepExecutionFilterKeyType,  # (1)
    Values: Sequence[str],
  1. See StepExecutionFilterKeyType

PatchOrchestratorFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import PatchOrchestratorFilterTypeDef

def get_value() -> PatchOrchestratorFilterTypeDef:
    return {
        "Key": ...,
    }
Definition
class PatchOrchestratorFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],

PatchTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import PatchTypeDef

def get_value() -> PatchTypeDef:
    return {
        "Id": ...,
    }
Definition
class PatchTypeDef(TypedDict):
    Id: NotRequired[str],
    ReleaseDate: NotRequired[datetime],
    Title: NotRequired[str],
    Description: NotRequired[str],
    ContentUrl: NotRequired[str],
    Vendor: NotRequired[str],
    ProductFamily: NotRequired[str],
    Product: NotRequired[str],
    Classification: NotRequired[str],
    MsrcSeverity: NotRequired[str],
    KbNumber: NotRequired[str],
    MsrcNumber: NotRequired[str],
    Language: NotRequired[str],
    AdvisoryIds: NotRequired[List[str]],
    BugzillaIds: NotRequired[List[str]],
    CVEIds: NotRequired[List[str]],
    Name: NotRequired[str],
    Epoch: NotRequired[int],
    Version: NotRequired[str],
    Release: NotRequired[str],
    Arch: NotRequired[str],
    Severity: NotRequired[str],
    Repository: NotRequired[str],

DescribeDocumentPermissionRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeDocumentPermissionRequestRequestTypeDef

def get_value() -> DescribeDocumentPermissionRequestRequestTypeDef:
    return {
        "Name": ...,
        "PermissionType": ...,
    }
Definition
class DescribeDocumentPermissionRequestRequestTypeDef(TypedDict):
    Name: str,
    PermissionType: DocumentPermissionTypeType,  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See DocumentPermissionTypeType

DescribeDocumentRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeDocumentRequestRequestTypeDef

def get_value() -> DescribeDocumentRequestRequestTypeDef:
    return {
        "Name": ...,
    }
Definition
class DescribeDocumentRequestRequestTypeDef(TypedDict):
    Name: str,
    DocumentVersion: NotRequired[str],
    VersionName: NotRequired[str],

DescribeEffectiveInstanceAssociationsRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeEffectiveInstanceAssociationsRequestRequestTypeDef

def get_value() -> DescribeEffectiveInstanceAssociationsRequestRequestTypeDef:
    return {
        "InstanceId": ...,
    }
Definition
class DescribeEffectiveInstanceAssociationsRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

InstanceAssociationTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import InstanceAssociationTypeDef

def get_value() -> InstanceAssociationTypeDef:
    return {
        "AssociationId": ...,
    }
Definition
class InstanceAssociationTypeDef(TypedDict):
    AssociationId: NotRequired[str],
    InstanceId: NotRequired[str],
    Content: NotRequired[str],
    AssociationVersion: NotRequired[str],

DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef

def get_value() -> DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef:
    return {
        "BaselineId": ...,
    }
Definition
class DescribeEffectivePatchesForPatchBaselineRequestRequestTypeDef(TypedDict):
    BaselineId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeInstanceAssociationsStatusRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeInstanceAssociationsStatusRequestRequestTypeDef

def get_value() -> DescribeInstanceAssociationsStatusRequestRequestTypeDef:
    return {
        "InstanceId": ...,
    }
Definition
class DescribeInstanceAssociationsStatusRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

InstanceInformationFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import InstanceInformationFilterTypeDef

def get_value() -> InstanceInformationFilterTypeDef:
    return {
        "key": ...,
        "valueSet": ...,
    }
Definition
class InstanceInformationFilterTypeDef(TypedDict):
    key: InstanceInformationFilterKeyType,  # (1)
    valueSet: Sequence[str],
  1. See InstanceInformationFilterKeyType

InstanceInformationStringFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import InstanceInformationStringFilterTypeDef

def get_value() -> InstanceInformationStringFilterTypeDef:
    return {
        "Key": ...,
        "Values": ...,
    }
Definition
class InstanceInformationStringFilterTypeDef(TypedDict):
    Key: str,
    Values: Sequence[str],

InstancePatchStateFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import InstancePatchStateFilterTypeDef

def get_value() -> InstancePatchStateFilterTypeDef:
    return {
        "Key": ...,
        "Values": ...,
        "Type": ...,
    }
Definition
class InstancePatchStateFilterTypeDef(TypedDict):
    Key: str,
    Values: Sequence[str],
    Type: InstancePatchStateOperatorTypeType,  # (1)
  1. See InstancePatchStateOperatorTypeType

InstancePatchStateTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import InstancePatchStateTypeDef

def get_value() -> InstancePatchStateTypeDef:
    return {
        "InstanceId": ...,
        "PatchGroup": ...,
        "BaselineId": ...,
        "OperationStartTime": ...,
        "OperationEndTime": ...,
        "Operation": ...,
    }
Definition
class InstancePatchStateTypeDef(TypedDict):
    InstanceId: str,
    PatchGroup: str,
    BaselineId: str,
    OperationStartTime: datetime,
    OperationEndTime: datetime,
    Operation: PatchOperationTypeType,  # (1)
    SnapshotId: NotRequired[str],
    InstallOverrideList: NotRequired[str],
    OwnerInformation: NotRequired[str],
    InstalledCount: NotRequired[int],
    InstalledOtherCount: NotRequired[int],
    InstalledPendingRebootCount: NotRequired[int],
    InstalledRejectedCount: NotRequired[int],
    MissingCount: NotRequired[int],
    FailedCount: NotRequired[int],
    UnreportedNotApplicableCount: NotRequired[int],
    NotApplicableCount: NotRequired[int],
    LastNoRebootInstallOperationTime: NotRequired[datetime],
    RebootOption: NotRequired[RebootOptionType],  # (2)
    CriticalNonCompliantCount: NotRequired[int],
    SecurityNonCompliantCount: NotRequired[int],
    OtherNonCompliantCount: NotRequired[int],
  1. See PatchOperationTypeType
  2. See RebootOptionType

DescribeInstancePatchStatesRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeInstancePatchStatesRequestRequestTypeDef

def get_value() -> DescribeInstancePatchStatesRequestRequestTypeDef:
    return {
        "InstanceIds": ...,
    }
Definition
class DescribeInstancePatchStatesRequestRequestTypeDef(TypedDict):
    InstanceIds: Sequence[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PatchComplianceDataTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import PatchComplianceDataTypeDef

def get_value() -> PatchComplianceDataTypeDef:
    return {
        "Title": ...,
        "KBId": ...,
        "Classification": ...,
        "Severity": ...,
        "State": ...,
        "InstalledTime": ...,
    }
Definition
class PatchComplianceDataTypeDef(TypedDict):
    Title: str,
    KBId: str,
    Classification: str,
    Severity: str,
    State: PatchComplianceDataStateType,  # (1)
    InstalledTime: datetime,
    CVEIds: NotRequired[str],
  1. See PatchComplianceDataStateType

DescribeInventoryDeletionsRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribeInventoryDeletionsRequestRequestTypeDef

def get_value() -> DescribeInventoryDeletionsRequestRequestTypeDef:
    return {
        "DeletionId": ...,
    }
Definition
class DescribeInventoryDeletionsRequestRequestTypeDef(TypedDict):
    DeletionId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MaintenanceWindowFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import MaintenanceWindowFilterTypeDef

def get_value() -> MaintenanceWindowFilterTypeDef:
    return {
        "Key": ...,
    }
Definition
class MaintenanceWindowFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],

MaintenanceWindowExecutionTaskInvocationIdentityTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import MaintenanceWindowExecutionTaskInvocationIdentityTypeDef

def get_value() -> MaintenanceWindowExecutionTaskInvocationIdentityTypeDef:
    return {
        "WindowExecutionId": ...,
    }
Definition
class MaintenanceWindowExecutionTaskInvocationIdentityTypeDef(TypedDict):
    WindowExecutionId: NotRequired[str],
    TaskExecutionId: NotRequired[str],
    InvocationId: NotRequired[str],
    ExecutionId: NotRequired[str],
    TaskType: NotRequired[MaintenanceWindowTaskTypeType],  # (1)
    Parameters: NotRequired[str],
    Status: NotRequired[MaintenanceWindowExecutionStatusType],  # (2)
    StatusDetails: NotRequired[str],
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    OwnerInformation: NotRequired[str],
    WindowTargetId: NotRequired[str],
  1. See MaintenanceWindowTaskTypeType
  2. See MaintenanceWindowExecutionStatusType

MaintenanceWindowExecutionTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import MaintenanceWindowExecutionTypeDef

def get_value() -> MaintenanceWindowExecutionTypeDef:
    return {
        "WindowId": ...,
    }
Definition
class MaintenanceWindowExecutionTypeDef(TypedDict):
    WindowId: NotRequired[str],
    WindowExecutionId: NotRequired[str],
    Status: NotRequired[MaintenanceWindowExecutionStatusType],  # (1)
    StatusDetails: NotRequired[str],
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
  1. See MaintenanceWindowExecutionStatusType

ScheduledWindowExecutionTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ScheduledWindowExecutionTypeDef

def get_value() -> ScheduledWindowExecutionTypeDef:
    return {
        "WindowId": ...,
    }
Definition
class ScheduledWindowExecutionTypeDef(TypedDict):
    WindowId: NotRequired[str],
    Name: NotRequired[str],
    ExecutionTime: NotRequired[str],

MaintenanceWindowIdentityForTargetTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import MaintenanceWindowIdentityForTargetTypeDef

def get_value() -> MaintenanceWindowIdentityForTargetTypeDef:
    return {
        "WindowId": ...,
    }
Definition
class MaintenanceWindowIdentityForTargetTypeDef(TypedDict):
    WindowId: NotRequired[str],
    Name: NotRequired[str],

MaintenanceWindowIdentityTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import MaintenanceWindowIdentityTypeDef

def get_value() -> MaintenanceWindowIdentityTypeDef:
    return {
        "WindowId": ...,
    }
Definition
class MaintenanceWindowIdentityTypeDef(TypedDict):
    WindowId: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    Enabled: NotRequired[bool],
    Duration: NotRequired[int],
    Cutoff: NotRequired[int],
    Schedule: NotRequired[str],
    ScheduleTimezone: NotRequired[str],
    ScheduleOffset: NotRequired[int],
    EndDate: NotRequired[str],
    StartDate: NotRequired[str],
    NextExecutionTime: NotRequired[str],

OpsItemFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import OpsItemFilterTypeDef

def get_value() -> OpsItemFilterTypeDef:
    return {
        "Key": ...,
        "Values": ...,
        "Operator": ...,
    }
Definition
class OpsItemFilterTypeDef(TypedDict):
    Key: OpsItemFilterKeyType,  # (1)
    Values: Sequence[str],
    Operator: OpsItemFilterOperatorType,  # (2)
  1. See OpsItemFilterKeyType
  2. See OpsItemFilterOperatorType

ParameterStringFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ParameterStringFilterTypeDef

def get_value() -> ParameterStringFilterTypeDef:
    return {
        "Key": ...,
    }
Definition
class ParameterStringFilterTypeDef(TypedDict):
    Key: str,
    Option: NotRequired[str],
    Values: NotRequired[Sequence[str]],

ParametersFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ParametersFilterTypeDef

def get_value() -> ParametersFilterTypeDef:
    return {
        "Key": ...,
        "Values": ...,
    }
Definition
class ParametersFilterTypeDef(TypedDict):
    Key: ParametersFilterKeyType,  # (1)
    Values: Sequence[str],
  1. See ParametersFilterKeyType

PatchBaselineIdentityTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import PatchBaselineIdentityTypeDef

def get_value() -> PatchBaselineIdentityTypeDef:
    return {
        "BaselineId": ...,
    }
Definition
class PatchBaselineIdentityTypeDef(TypedDict):
    BaselineId: NotRequired[str],
    BaselineName: NotRequired[str],
    OperatingSystem: NotRequired[OperatingSystemType],  # (1)
    BaselineDescription: NotRequired[str],
    DefaultBaseline: NotRequired[bool],
  1. See OperatingSystemType

DescribePatchGroupStateRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribePatchGroupStateRequestRequestTypeDef

def get_value() -> DescribePatchGroupStateRequestRequestTypeDef:
    return {
        "PatchGroup": ...,
    }
Definition
class DescribePatchGroupStateRequestRequestTypeDef(TypedDict):
    PatchGroup: str,

DescribePatchPropertiesRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DescribePatchPropertiesRequestRequestTypeDef

def get_value() -> DescribePatchPropertiesRequestRequestTypeDef:
    return {
        "OperatingSystem": ...,
        "Property": ...,
    }
Definition
class DescribePatchPropertiesRequestRequestTypeDef(TypedDict):
    OperatingSystem: OperatingSystemType,  # (1)
    Property: PatchPropertyType,  # (2)
    PatchSet: NotRequired[PatchSetType],  # (3)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See OperatingSystemType
  2. See PatchPropertyType
  3. See PatchSetType

SessionFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import SessionFilterTypeDef

def get_value() -> SessionFilterTypeDef:
    return {
        "key": ...,
        "value": ...,
    }
Definition
class SessionFilterTypeDef(TypedDict):
    key: SessionFilterKeyType,  # (1)
    value: str,
  1. See SessionFilterKeyType

DisassociateOpsItemRelatedItemRequestRequestTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DisassociateOpsItemRelatedItemRequestRequestTypeDef

def get_value() -> DisassociateOpsItemRelatedItemRequestRequestTypeDef:
    return {
        "OpsItemId": ...,
        "AssociationId": ...,
    }
Definition
class DisassociateOpsItemRelatedItemRequestRequestTypeDef(TypedDict):
    OpsItemId: str,
    AssociationId: str,

DocumentDefaultVersionDescriptionTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DocumentDefaultVersionDescriptionTypeDef

def get_value() -> DocumentDefaultVersionDescriptionTypeDef:
    return {
        "Name": ...,
    }
Definition
class DocumentDefaultVersionDescriptionTypeDef(TypedDict):
    Name: NotRequired[str],
    DefaultVersion: NotRequired[str],
    DefaultVersionName: NotRequired[str],

DocumentParameterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DocumentParameterTypeDef

def get_value() -> DocumentParameterTypeDef:
    return {
        "Name": ...,
    }
Definition
class DocumentParameterTypeDef(TypedDict):
    Name: NotRequired[str],
    Type: NotRequired[DocumentParameterTypeType],  # (1)
    Description: NotRequired[str],
    DefaultValue: NotRequired[str],
  1. See DocumentParameterTypeType

ReviewInformationTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import ReviewInformationTypeDef

def get_value() -> ReviewInformationTypeDef:
    return {
        "ReviewedTime": ...,
    }
Definition
class ReviewInformationTypeDef(TypedDict):
    ReviewedTime: NotRequired[datetime],
    Status: NotRequired[ReviewStatusType],  # (1)
    Reviewer: NotRequired[str],
  1. See ReviewStatusType

DocumentFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DocumentFilterTypeDef

def get_value() -> DocumentFilterTypeDef:
    return {
        "key": ...,
        "value": ...,
    }
Definition
class DocumentFilterTypeDef(TypedDict):
    key: DocumentFilterKeyType,  # (1)
    value: str,
  1. See DocumentFilterKeyType

DocumentKeyValuesFilterTypeDef

Usage Example
from mypy_boto3_ssm.type_defs import DocumentKeyValuesFilterTypeDef

def get_value() -> DocumentKeyValuesFilterTypeDef:
    return {
        "Key": ...,
    }
Definition