SSM class

AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.

Constructors

SSM({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addTagsToResource({required String resourceId, required ResourceTypeForTagging resourceType, required List<Tag> tags}) → Future<void>
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
cancelCommand({required String commandId, List<String>? instanceIds}) → Future<void>
Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelMaintenanceWindowExecution({required String windowExecutionId}) → Future<CancelMaintenanceWindowExecutionResult>
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createActivation({required String iamRole, String? defaultInstanceName, String? description, DateTime? expirationDate, int? registrationLimit, List<Tag>? tags}) → Future<CreateActivationResult>
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
createAssociation({required String name, bool? applyOnlyAtCronInterval, String? associationName, String? automationTargetParameterName, AssociationComplianceSeverity? complianceSeverity, String? documentVersion, String? instanceId, String? maxConcurrency, String? maxErrors, InstanceAssociationOutputLocation? outputLocation, Map<String, List<String>>? parameters, String? scheduleExpression, AssociationSyncCompliance? syncCompliance, List<TargetLocation>? targetLocations, List<Target>? targets}) → Future<CreateAssociationResult>
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
createAssociationBatch({required List<CreateAssociationBatchRequestEntry> entries}) → Future<CreateAssociationBatchResult>
Associates the specified Systems Manager document with the specified instances or targets.
createDocument({required String content, required String name, List<AttachmentsSource>? attachments, DocumentFormat? documentFormat, DocumentType? documentType, List<DocumentRequires>? requires, List<Tag>? tags, String? targetType, String? versionName}) → Future<CreateDocumentResult>
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
createMaintenanceWindow({required bool allowUnassociatedTargets, required int cutoff, required int duration, required String name, required String schedule, String? clientToken, String? description, String? endDate, int? scheduleOffset, String? scheduleTimezone, String? startDate, List<Tag>? tags}) → Future<CreateMaintenanceWindowResult>
Creates a new maintenance window.
createOpsItem({required String description, required String source, required String title, DateTime? actualEndTime, DateTime? actualStartTime, String? category, List<OpsItemNotification>? notifications, Map<String, OpsItemDataValue>? operationalData, String? opsItemType, DateTime? plannedEndTime, DateTime? plannedStartTime, int? priority, List<RelatedOpsItem>? relatedOpsItems, String? severity, List<Tag>? tags}) → Future<CreateOpsItemResponse>
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
createOpsMetadata({required String resourceId, Map<String, MetadataValue>? metadata}) → Future<CreateOpsMetadataResult>
If you create a new application in Application Manager, Systems Manager calls this API action to specify information about the new application, including the application type.
createPatchBaseline({required String name, PatchRuleGroup? approvalRules, List<String>? approvedPatches, PatchComplianceLevel? approvedPatchesComplianceLevel, bool? approvedPatchesEnableNonSecurity, String? clientToken, String? description, PatchFilterGroup? globalFilters, OperatingSystem? operatingSystem, List<String>? rejectedPatches, PatchAction? rejectedPatchesAction, List<PatchSource>? sources, List<Tag>? tags}) → Future<CreatePatchBaselineResult>
Creates a patch baseline.
createResourceDataSync({required String syncName, ResourceDataSyncS3Destination? s3Destination, ResourceDataSyncSource? syncSource, String? syncType}) → Future<void>
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.
deleteActivation({required String activationId}) → Future<void>
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
deleteAssociation({String? associationId, String? instanceId, String? name}) → Future<void>
Disassociates the specified Systems Manager document from the specified instance.
deleteDocument({required String name, String? documentVersion, bool? force, String? versionName}) → Future<void>
Deletes the Systems Manager document and all instance associations to the document.
deleteInventory({required String typeName, String? clientToken, bool? dryRun, InventorySchemaDeleteOption? schemaDeleteOption}) → Future<DeleteInventoryResult>
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteMaintenanceWindow({required String windowId}) → Future<DeleteMaintenanceWindowResult>
Deletes a maintenance window.
deleteOpsMetadata({required String opsMetadataArn}) → Future<void>
Delete OpsMetadata related to an application.
deleteParameter({required String name}) → Future<void>
Delete a parameter from the system.
deleteParameters({required List<String> names}) → Future<DeleteParametersResult>
Delete a list of parameters.
deletePatchBaseline({required String baselineId}) → Future<DeletePatchBaselineResult>
Deletes a patch baseline.
deleteResourceDataSync({required String syncName, String? syncType}) → Future<void>
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
deregisterManagedInstance({required String instanceId}) → Future<void>
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterPatchBaselineForPatchGroup({required String baselineId, required String patchGroup}) → Future<DeregisterPatchBaselineForPatchGroupResult>
Removes a patch group from a patch baseline.
deregisterTargetFromMaintenanceWindow({required String windowId, required String windowTargetId, bool? safe}) → Future<DeregisterTargetFromMaintenanceWindowResult>
Removes a target from a maintenance window.
deregisterTaskFromMaintenanceWindow({required String windowId, required String windowTaskId}) → Future<DeregisterTaskFromMaintenanceWindowResult>
Removes a task from a maintenance window.
describeActivations({List<DescribeActivationsFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeActivationsResult>
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
describeAssociation({String? associationId, String? associationVersion, String? instanceId, String? name}) → Future<DescribeAssociationResult>
Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.
describeAssociationExecutions({required String associationId, List<AssociationExecutionFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeAssociationExecutionsResult>
Use this API action to view all executions for a specific association ID.
describeAssociationExecutionTargets({required String associationId, required String executionId, List<AssociationExecutionTargetsFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeAssociationExecutionTargetsResult>
Use this API action to view information about a specific execution of a specific association.
describeAutomationExecutions({List<AutomationExecutionFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeAutomationExecutionsResult>
Provides details about all active and terminated Automation executions.
describeAutomationStepExecutions({required String automationExecutionId, List<StepExecutionFilter>? filters, int? maxResults, String? nextToken, bool? reverseOrder}) → Future<DescribeAutomationStepExecutionsResult>
Information about all active and terminated step executions in an Automation workflow.
describeAvailablePatches({List<PatchOrchestratorFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeAvailablePatchesResult>
Lists all patches eligible to be included in a patch baseline.
describeDocument({required String name, String? documentVersion, String? versionName}) → Future<DescribeDocumentResult>
Describes the specified Systems Manager document.
describeDocumentPermission({required String name, required DocumentPermissionType permissionType}) → Future<DescribeDocumentPermissionResponse>
Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
describeEffectiveInstanceAssociations({required String instanceId, int? maxResults, String? nextToken}) → Future<DescribeEffectiveInstanceAssociationsResult>
All associations for the instance(s).
describeEffectivePatchesForPatchBaseline({required String baselineId, int? maxResults, String? nextToken}) → Future<DescribeEffectivePatchesForPatchBaselineResult>
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeInstanceAssociationsStatus({required String instanceId, int? maxResults, String? nextToken}) → Future<DescribeInstanceAssociationsStatusResult>
The status of the associations for the instance(s).
describeInstanceInformation({List<InstanceInformationStringFilter>? filters, List<InstanceInformationFilter>? instanceInformationFilterList, int? maxResults, String? nextToken}) → Future<DescribeInstanceInformationResult>
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
describeInstancePatches({required String instanceId, List<PatchOrchestratorFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeInstancePatchesResult>
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatchStates({required List<String> instanceIds, int? maxResults, String? nextToken}) → Future<DescribeInstancePatchStatesResult>
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStatesForPatchGroup({required String patchGroup, List<InstancePatchStateFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeInstancePatchStatesForPatchGroupResult>
Retrieves the high-level patch state for the instances in the specified patch group.
describeInventoryDeletions({String? deletionId, int? maxResults, String? nextToken}) → Future<DescribeInventoryDeletionsResult>
Describes a specific delete inventory operation.
describeMaintenanceWindowExecutions({required String windowId, List<MaintenanceWindowFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeMaintenanceWindowExecutionsResult>
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
describeMaintenanceWindowExecutionTaskInvocations({required String taskId, required String windowExecutionId, List<MaintenanceWindowFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeMaintenanceWindowExecutionTaskInvocationsResult>
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTasks({required String windowExecutionId, List<MaintenanceWindowFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeMaintenanceWindowExecutionTasksResult>
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindows({List<MaintenanceWindowFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeMaintenanceWindowsResult>
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindowSchedule({List<PatchOrchestratorFilter>? filters, int? maxResults, String? nextToken, MaintenanceWindowResourceType? resourceType, List<Target>? targets, String? windowId}) → Future<DescribeMaintenanceWindowScheduleResult>
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowsForTarget({required MaintenanceWindowResourceType resourceType, required List<Target> targets, int? maxResults, String? nextToken}) → Future<DescribeMaintenanceWindowsForTargetResult>
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowTargets({required String windowId, List<MaintenanceWindowFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeMaintenanceWindowTargetsResult>
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTasks({required String windowId, List<MaintenanceWindowFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeMaintenanceWindowTasksResult>
Lists the tasks in a maintenance window.
describeOpsItems({int? maxResults, String? nextToken, List<OpsItemFilter>? opsItemFilters}) → Future<DescribeOpsItemsResponse>
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
describeParameters({List<ParametersFilter>? filters, int? maxResults, String? nextToken, List<ParameterStringFilter>? parameterFilters}) → Future<DescribeParametersResult>
Get information about a parameter.
describePatchBaselines({List<PatchOrchestratorFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribePatchBaselinesResult>
Lists the patch baselines in your AWS account.
describePatchGroups({List<PatchOrchestratorFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribePatchGroupsResult>
Lists all patch groups that have been registered with patch baselines.
describePatchGroupState({required String patchGroup}) → Future<DescribePatchGroupStateResult>
Returns high-level aggregated patch compliance state for a patch group.
describePatchProperties({required OperatingSystem operatingSystem, required PatchProperty property, int? maxResults, String? nextToken, PatchSet? patchSet}) → Future<DescribePatchPropertiesResult>
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
describeSessions({required SessionState state, List<SessionFilter>? filters, int? maxResults, String? nextToken}) → Future<DescribeSessionsResponse>
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
getAutomationExecution({required String automationExecutionId}) → Future<GetAutomationExecutionResult>
Get detailed information about a particular Automation execution.
getCalendarState({required List<String> calendarNames, String? atTime}) → Future<GetCalendarStateResponse>
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time, GetCalendarState returns the state of the calendar at a specific time, and returns the next time that the Change Calendar state will transition. If you do not specify a time, GetCalendarState assumes the current time. Change Calendar entries have two possible states: OPEN or CLOSED.
getCommandInvocation({required String commandId, required String instanceId, String? pluginName}) → Future<GetCommandInvocationResult>
Returns detailed information about command execution for an invocation or plugin.
getConnectionStatus({required String target}) → Future<GetConnectionStatusResponse>
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
getDefaultPatchBaseline({OperatingSystem? operatingSystem}) → Future<GetDefaultPatchBaselineResult>
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
getDeployablePatchSnapshotForInstance({required String instanceId, required String snapshotId}) → Future<GetDeployablePatchSnapshotForInstanceResult>
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDocument({required String name, DocumentFormat? documentFormat, String? documentVersion, String? versionName}) → Future<GetDocumentResult>
Gets the contents of the specified Systems Manager document.
getInventory({List<InventoryAggregator>? aggregators, List<InventoryFilter>? filters, int? maxResults, String? nextToken, List<ResultAttribute>? resultAttributes}) → Future<GetInventoryResult>
Query inventory information.
getInventorySchema({bool? aggregator, int? maxResults, String? nextToken, bool? subType, String? typeName}) → Future<GetInventorySchemaResult>
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getMaintenanceWindow({required String windowId}) → Future<GetMaintenanceWindowResult>
Retrieves a maintenance window.
getMaintenanceWindowExecution({required String windowExecutionId}) → Future<GetMaintenanceWindowExecutionResult>
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionTask({required String taskId, required String windowExecutionId}) → Future<GetMaintenanceWindowExecutionTaskResult>
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskInvocation({required String invocationId, required String taskId, required String windowExecutionId}) → Future<GetMaintenanceWindowExecutionTaskInvocationResult>
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowTask({required String windowId, required String windowTaskId}) → Future<GetMaintenanceWindowTaskResult>
Lists the tasks in a maintenance window.
getOpsItem({required String opsItemId}) → Future<GetOpsItemResponse>
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
getOpsMetadata({required String opsMetadataArn, int? maxResults, String? nextToken}) → Future<GetOpsMetadataResult>
View operational metadata related to an application in Application Manager.
getOpsSummary({List<OpsAggregator>? aggregators, List<OpsFilter>? filters, int? maxResults, String? nextToken, List<OpsResultAttribute>? resultAttributes, String? syncName}) → Future<GetOpsSummaryResult>
View a summary of OpsItems based on specified filters and aggregators.
getParameter({required String name, bool? withDecryption}) → Future<GetParameterResult>
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameterHistory({required String name, int? maxResults, String? nextToken, bool? withDecryption}) → Future<GetParameterHistoryResult>
Retrieves the history of all changes to a parameter.
getParameters({required List<String> names, bool? withDecryption}) → Future<GetParametersResult>
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
getParametersByPath({required String path, int? maxResults, String? nextToken, List<ParameterStringFilter>? parameterFilters, bool? recursive, bool? withDecryption}) → Future<GetParametersByPathResult>
Retrieve information about one or more parameters in a specific hierarchy.
getPatchBaseline({required String baselineId}) → Future<GetPatchBaselineResult>
Retrieves information about a patch baseline.
getPatchBaselineForPatchGroup({required String patchGroup, OperatingSystem? operatingSystem}) → Future<GetPatchBaselineForPatchGroupResult>
Retrieves the patch baseline that should be used for the specified patch group.
getServiceSetting({required String settingId}) → Future<GetServiceSettingResult>
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.
labelParameterVersion({required List<String> labels, required String name, int? parameterVersion}) → Future<LabelParameterVersionResult>
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
listAssociations({List<AssociationFilter>? associationFilterList, int? maxResults, String? nextToken}) → Future<ListAssociationsResult>
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
listAssociationVersions({required String associationId, int? maxResults, String? nextToken}) → Future<ListAssociationVersionsResult>
Retrieves all versions of an association for a specific association ID.
listCommandInvocations({String? commandId, bool? details, List<CommandFilter>? filters, String? instanceId, int? maxResults, String? nextToken}) → Future<ListCommandInvocationsResult>
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
listCommands({String? commandId, List<CommandFilter>? filters, String? instanceId, int? maxResults, String? nextToken}) → Future<ListCommandsResult>
Lists the commands requested by users of the AWS account.
listComplianceItems({List<ComplianceStringFilter>? filters, int? maxResults, String? nextToken, List<String>? resourceIds, List<String>? resourceTypes}) → Future<ListComplianceItemsResult>
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceSummaries({List<ComplianceStringFilter>? filters, int? maxResults, String? nextToken}) → Future<ListComplianceSummariesResult>
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
listDocumentMetadataHistory({required DocumentMetadataEnum metadata, required String name, String? documentVersion, int? maxResults, String? nextToken}) → Future<ListDocumentMetadataHistoryResponse>
Information about approval reviews for a version of an SSM document.
listDocuments({List<DocumentFilter>? documentFilterList, List<DocumentKeyValuesFilter>? filters, int? maxResults, String? nextToken}) → Future<ListDocumentsResult>
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
listDocumentVersions({required String name, int? maxResults, String? nextToken}) → Future<ListDocumentVersionsResult>
List all versions for a document.
listInventoryEntries({required String instanceId, required String typeName, List<InventoryFilter>? filters, int? maxResults, String? nextToken}) → Future<ListInventoryEntriesResult>
A list of inventory items returned by the request.
listOpsItemEvents({List<OpsItemEventFilter>? filters, int? maxResults, String? nextToken}) → Future<ListOpsItemEventsResponse>
Returns a list of all OpsItem events in the current AWS account and Region. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsMetadata({List<OpsMetadataFilter>? filters, int? maxResults, String? nextToken}) → Future<ListOpsMetadataResult>
Systems Manager calls this API action when displaying all Application Manager OpsMetadata objects or blobs.
listResourceComplianceSummaries({List<ComplianceStringFilter>? filters, int? maxResults, String? nextToken}) → Future<ListResourceComplianceSummariesResult>
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
listResourceDataSync({int? maxResults, String? nextToken, String? syncType}) → Future<ListResourceDataSyncResult>
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
listTagsForResource({required String resourceId, required ResourceTypeForTagging resourceType}) → Future<ListTagsForResourceResult>
Returns a list of the tags assigned to the specified resource.
modifyDocumentPermission({required String name, required DocumentPermissionType permissionType, List<String>? accountIdsToAdd, List<String>? accountIdsToRemove, String? sharedDocumentVersion}) → Future<void>
Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putComplianceItems({required String complianceType, required ComplianceExecutionSummary executionSummary, required List<ComplianceItemEntry> items, required String resourceId, required String resourceType, String? itemContentHash, ComplianceUploadType? uploadType}) → Future<void>
Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
putInventory({required String instanceId, required List<InventoryItem> items}) → Future<PutInventoryResult>
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putParameter({required String name, required String value, String? allowedPattern, String? dataType, String? description, String? keyId, bool? overwrite, String? policies, List<Tag>? tags, ParameterTier? tier, ParameterType? type}) → Future<PutParameterResult>
Add a parameter to the system.
registerDefaultPatchBaseline({required String baselineId}) → Future<RegisterDefaultPatchBaselineResult>
Defines the default patch baseline for the relevant operating system.
registerPatchBaselineForPatchGroup({required String baselineId, required String patchGroup}) → Future<RegisterPatchBaselineForPatchGroupResult>
Registers a patch baseline for a patch group.
registerTargetWithMaintenanceWindow({required MaintenanceWindowResourceType resourceType, required List<Target> targets, required String windowId, String? clientToken, String? description, String? name, String? ownerInformation}) → Future<RegisterTargetWithMaintenanceWindowResult>
Registers a target with a maintenance window.
registerTaskWithMaintenanceWindow({required String taskArn, required MaintenanceWindowTaskType taskType, required String windowId, String? clientToken, String? description, LoggingInfo? loggingInfo, String? maxConcurrency, String? maxErrors, String? name, int? priority, String? serviceRoleArn, List<Target>? targets, MaintenanceWindowTaskInvocationParameters? taskInvocationParameters, Map<String, MaintenanceWindowTaskParameterValueExpression>? taskParameters}) → Future<RegisterTaskWithMaintenanceWindowResult>
Adds a new task to a maintenance window.
removeTagsFromResource({required String resourceId, required ResourceTypeForTagging resourceType, required List<String> tagKeys}) → Future<void>
Removes tag keys from the specified resource.
resetServiceSetting({required String settingId}) → Future<ResetServiceSettingResult>
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.
resumeSession({required String sessionId}) → Future<ResumeSessionResponse>
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
sendAutomationSignal({required String automationExecutionId, required SignalType signalType, Map<String, List<String>>? payload}) → Future<void>
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendCommand({required String documentName, CloudWatchOutputConfig? cloudWatchOutputConfig, String? comment, String? documentHash, DocumentHashType? documentHashType, String? documentVersion, List<String>? instanceIds, String? maxConcurrency, String? maxErrors, NotificationConfig? notificationConfig, String? outputS3BucketName, String? outputS3KeyPrefix, String? outputS3Region, Map<String, List<String>>? parameters, String? serviceRoleArn, List<Target>? targets, int? timeoutSeconds}) → Future<SendCommandResult>
Runs commands on one or more managed instances.
startAssociationsOnce({required List<String> associationIds}) → Future<void>
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
startAutomationExecution({required String documentName, String? clientToken, String? documentVersion, String? maxConcurrency, String? maxErrors, ExecutionMode? mode, Map<String, List<String>>? parameters, List<Tag>? tags, List<TargetLocation>? targetLocations, List<Map<String, List<String>>>? targetMaps, String? targetParameterName, List<Target>? targets}) → Future<StartAutomationExecutionResult>
Initiates execution of an Automation document.
startChangeRequestExecution({required String documentName, required List<Runbook> runbooks, String? changeRequestName, String? clientToken, String? documentVersion, Map<String, List<String>>? parameters, DateTime? scheduledTime, List<Tag>? tags}) → Future<StartChangeRequestExecutionResult>
Creates a change request for Change Manager. The runbooks (Automation documents) specified in the change request run only after all required approvals for the change request have been received.
startSession({required String target, String? documentName, Map<String, List<String>>? parameters}) → Future<StartSessionResponse>
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
stopAutomationExecution({required String automationExecutionId, StopType? type}) → Future<void>
Stop an Automation that is currently running.
terminateSession({required String sessionId}) → Future<TerminateSessionResponse>
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
toString() → String
A string representation of this object.
inherited
updateAssociation({required String associationId, bool? applyOnlyAtCronInterval, String? associationName, String? associationVersion, String? automationTargetParameterName, AssociationComplianceSeverity? complianceSeverity, String? documentVersion, String? maxConcurrency, String? maxErrors, String? name, InstanceAssociationOutputLocation? outputLocation, Map<String, List<String>>? parameters, String? scheduleExpression, AssociationSyncCompliance? syncCompliance, List<TargetLocation>? targetLocations, List<Target>? targets}) → Future<UpdateAssociationResult>
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
updateAssociationStatus({required AssociationStatus associationStatus, required String instanceId, required String name}) → Future<UpdateAssociationStatusResult>
Updates the status of the Systems Manager document associated with the specified instance.
updateDocument({required String content, required String name, List<AttachmentsSource>? attachments, DocumentFormat? documentFormat, String? documentVersion, String? targetType, String? versionName}) → Future<UpdateDocumentResult>
Updates one or more values for an SSM document.
updateDocumentDefaultVersion({required String documentVersion, required String name}) → Future<UpdateDocumentDefaultVersionResult>
Set the default version of a document.
updateDocumentMetadata({required DocumentReviews documentReviews, required String name, String? documentVersion}) → Future<void>
Updates information related to approval reviews for a specific version of a document.
updateMaintenanceWindow({required String windowId, bool? allowUnassociatedTargets, int? cutoff, String? description, int? duration, bool? enabled, String? endDate, String? name, bool? replace, String? schedule, int? scheduleOffset, String? scheduleTimezone, String? startDate}) → Future<UpdateMaintenanceWindowResult>
Updates an existing maintenance window. Only specified parameters are modified.
updateMaintenanceWindowTarget({required String windowId, required String windowTargetId, String? description, String? name, String? ownerInformation, bool? replace, List<Target>? targets}) → Future<UpdateMaintenanceWindowTargetResult>
Modifies the target of an existing maintenance window. You can change the following:
updateMaintenanceWindowTask({required String windowId, required String windowTaskId, String? description, LoggingInfo? loggingInfo, String? maxConcurrency, String? maxErrors, String? name, int? priority, bool? replace, String? serviceRoleArn, List<Target>? targets, String? taskArn, MaintenanceWindowTaskInvocationParameters? taskInvocationParameters, Map<String, MaintenanceWindowTaskParameterValueExpression>? taskParameters}) → Future<UpdateMaintenanceWindowTaskResult>
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
updateManagedInstanceRole({required String iamRole, required String instanceId}) → Future<void>
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
updateOpsItem({required String opsItemId, DateTime? actualEndTime, DateTime? actualStartTime, String? category, String? description, List<OpsItemNotification>? notifications, Map<String, OpsItemDataValue>? operationalData, List<String>? operationalDataToDelete, DateTime? plannedEndTime, DateTime? plannedStartTime, int? priority, List<RelatedOpsItem>? relatedOpsItems, String? severity, OpsItemStatus? status, String? title}) → Future<void>
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
updateOpsMetadata({required String opsMetadataArn, List<String>? keysToDelete, Map<String, MetadataValue>? metadataToUpdate}) → Future<UpdateOpsMetadataResult>
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
updatePatchBaseline({required String baselineId, PatchRuleGroup? approvalRules, List<String>? approvedPatches, PatchComplianceLevel? approvedPatchesComplianceLevel, bool? approvedPatchesEnableNonSecurity, String? description, PatchFilterGroup? globalFilters, String? name, List<String>? rejectedPatches, PatchAction? rejectedPatchesAction, bool? replace, List<PatchSource>? sources}) → Future<UpdatePatchBaselineResult>
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
updateResourceDataSync({required String syncName, required ResourceDataSyncSource syncSource, required String syncType}) → Future<void>
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
updateServiceSetting({required String settingId, required String settingValue}) → Future<void>
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

Operators

operator ==(Object other) → bool
The equality operator.
inherited