flowground for Business Customers
Amazon Simple Systems Manager (SSM)
Connector for

Amazon Simple Systems Manager (SSM)

AWS Systems Manager

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 EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.

This reference is intended to be used with the AWS Systems Manager User Guide.

To get started, verify prerequisites and configure managed instances. For more information, see Systems Manager Prerequisites in the AWS Systems Manager User Guide.

For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.

Specifications
  • Category: Office
  • Provider: n/a
  • Used API: -
  • Managed: -
  • License: Apache License 2.0
  • Programmed with: javascript
Prices

For productive use you need a project room, which is subject to a fee.

Prices & Editions

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

AddTagsToResource

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.

Each resource can have a maximum of 50 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

OnInit
./lib/actions/AddTagsToResource.js
OnStartup
-
OnClose
-

Attributes

-

CancelCommand

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.

OnInit
./lib/actions/CancelCommand.js
OnStartup
-
OnClose
-

Attributes

-

CancelMaintenanceWindowExecution

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

OnInit
./lib/actions/CancelMaintenanceWindowExecution.js
OnStartup
-
OnClose
-

Attributes

-

CreateActivation

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.

OnInit
./lib/actions/CreateActivation.js
OnStartup
-
OnClose
-

Attributes

-

CreateAssociation

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

OnInit
./lib/actions/CreateAssociation.js
OnStartup
-
OnClose
-

Attributes

-

CreateAssociationBatch

Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

OnInit
./lib/actions/CreateAssociationBatch.js
OnStartup
-
OnClose
-

Attributes

-

CreateDocument

Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

OnInit
./lib/actions/CreateDocument.js
OnStartup
-
OnClose
-

Attributes

-

CreateMaintenanceWindow

Creates a new Maintenance Window.

OnInit
./lib/actions/CreateMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

CreatePatchBaseline

Creates a patch baseline.

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

OnInit
./lib/actions/CreatePatchBaseline.js
OnStartup
-
OnClose
-

Attributes

-

CreateResourceDataSync

Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.

OnInit
./lib/actions/CreateResourceDataSync.js
OnStartup
-
OnClose
-

Attributes

-

DeleteActivation

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.

OnInit
./lib/actions/DeleteActivation.js
OnStartup
-
OnClose
-

Attributes

-

DeleteAssociation

Disassociates the specified Systems Manager document from the specified instance.

When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

OnInit
./lib/actions/DeleteAssociation.js
OnStartup
-
OnClose
-

Attributes

-

DeleteDocument

Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

OnInit
./lib/actions/DeleteDocument.js
OnStartup
-
OnClose
-

Attributes

-

DeleteInventory

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.

OnInit
./lib/actions/DeleteInventory.js
OnStartup
-
OnClose
-

Attributes

-

DeleteMaintenanceWindow

Deletes a Maintenance Window.

OnInit
./lib/actions/DeleteMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

DeleteParameter

Delete a parameter from the system.

OnInit
./lib/actions/DeleteParameter.js
OnStartup
-
OnClose
-

Attributes

-

DeleteParameters

Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.

OnInit
./lib/actions/DeleteParameters.js
OnStartup
-
OnClose
-

Attributes

-

DeletePatchBaseline

Deletes a patch baseline.

OnInit
./lib/actions/DeletePatchBaseline.js
OnStartup
-
OnClose
-

Attributes

-

DeleteResourceDataSync

Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.

OnInit
./lib/actions/DeleteResourceDataSync.js
OnStartup
-
OnClose
-

Attributes

-

DeregisterManagedInstance

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.

OnInit
./lib/actions/DeregisterManagedInstance.js
OnStartup
-
OnClose
-

Attributes

-

DeregisterPatchBaselineForPatchGroup

Removes a patch group from a patch baseline.

OnInit
./lib/actions/DeregisterPatchBaselineForPatchGroup.js
OnStartup
-
OnClose
-

Attributes

-

DeregisterTargetFromMaintenanceWindow

Removes a target from a Maintenance Window.

OnInit
./lib/actions/DeregisterTargetFromMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

DeregisterTaskFromMaintenanceWindow

Removes a task from a Maintenance Window.

OnInit
./lib/actions/DeregisterTaskFromMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

DescribeActivations

Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.

OnInit
./lib/actions/DescribeActivations.js
OnStartup
-
OnClose
-

Attributes

-

DescribeAssociation

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.

OnInit
./lib/actions/DescribeAssociation.js
OnStartup
-
OnClose
-

Attributes

-

DescribeAssociationExecutionTargets

Use this API action to view information about a specific execution of a specific association.

OnInit
./lib/actions/DescribeAssociationExecutionTargets.js
OnStartup
-
OnClose
-

Attributes

-

DescribeAssociationExecutions

Use this API action to view all executions for a specific association ID.

OnInit
./lib/actions/DescribeAssociationExecutions.js
OnStartup
-
OnClose
-

Attributes

-

DescribeAutomationExecutions

Provides details about all active and terminated Automation executions.

OnInit
./lib/actions/DescribeAutomationExecutions.js
OnStartup
-
OnClose
-

Attributes

-

DescribeAutomationStepExecutions

Information about all active and terminated step executions in an Automation workflow.

OnInit
./lib/actions/DescribeAutomationStepExecutions.js
OnStartup
-
OnClose
-

Attributes

-

DescribeAvailablePatches

Lists all patches that could possibly be included in a patch baseline.

OnInit
./lib/actions/DescribeAvailablePatches.js
OnStartup
-
OnClose
-

Attributes

-

DescribeDocument

Describes the specified Systems Manager document.

OnInit
./lib/actions/DescribeDocument.js
OnStartup
-
OnClose
-

Attributes

-

DescribeDocumentPermission

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

OnInit
./lib/actions/DescribeDocumentPermission.js
OnStartup
-
OnClose
-

Attributes

-

DescribeEffectiveInstanceAssociations

All associations for the instance(s).

OnInit
./lib/actions/DescribeEffectiveInstanceAssociations.js
OnStartup
-
OnClose
-

Attributes

-

DescribeEffectivePatchesForPatchBaseline

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.

OnInit
./lib/actions/DescribeEffectivePatchesForPatchBaseline.js
OnStartup
-
OnClose
-

Attributes

-

DescribeInstanceAssociationsStatus

The status of the associations for the instance(s).

OnInit
./lib/actions/DescribeInstanceAssociationsStatus.js
OnStartup
-
OnClose
-

Attributes

-

DescribeInstanceInformation

Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.

OnInit
./lib/actions/DescribeInstanceInformation.js
OnStartup
-
OnClose
-

Attributes

-

DescribeInstancePatchStates

Retrieves the high-level patch state of one or more instances.

OnInit
./lib/actions/DescribeInstancePatchStates.js
OnStartup
-
OnClose
-

Attributes

-

DescribeInstancePatchStatesForPatchGroup

Retrieves the high-level patch state for the instances in the specified patch group.

OnInit
./lib/actions/DescribeInstancePatchStatesForPatchGroup.js
OnStartup
-
OnClose
-

Attributes

-

DescribeInstancePatches

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

OnInit
./lib/actions/DescribeInstancePatches.js
OnStartup
-
OnClose
-

Attributes

-

DescribeInventoryDeletions

Describes a specific delete inventory operation.

OnInit
./lib/actions/DescribeInventoryDeletions.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindowExecutionTaskInvocations

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.

OnInit
./lib/actions/DescribeMaintenanceWindowExecutionTaskInvocations.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindowExecutionTasks

For a given Maintenance Window execution, lists the tasks that were executed.

OnInit
./lib/actions/DescribeMaintenanceWindowExecutionTasks.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindowExecutions

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.

OnInit
./lib/actions/DescribeMaintenanceWindowExecutions.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindowSchedule

Retrieves information about upcoming executions of a Maintenance Window.

OnInit
./lib/actions/DescribeMaintenanceWindowSchedule.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindowTargets

Lists the targets registered with the Maintenance Window.

OnInit
./lib/actions/DescribeMaintenanceWindowTargets.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindowTasks

Lists the tasks in a Maintenance Window.

OnInit
./lib/actions/DescribeMaintenanceWindowTasks.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindows

Retrieves the Maintenance Windows in an AWS account.

OnInit
./lib/actions/DescribeMaintenanceWindows.js
OnStartup
-
OnClose
-

Attributes

-

DescribeMaintenanceWindowsForTarget

Retrieves information about the Maintenance Windows targets or tasks that an instance is associated with.

OnInit
./lib/actions/DescribeMaintenanceWindowsForTarget.js
OnStartup
-
OnClose
-

Attributes

-

DescribeParameters

Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

OnInit
./lib/actions/DescribeParameters.js
OnStartup
-
OnClose
-

Attributes

-

DescribePatchBaselines

Lists the patch baselines in your AWS account.

OnInit
./lib/actions/DescribePatchBaselines.js
OnStartup
-
OnClose
-

Attributes

-

DescribePatchGroupState

Returns high-level aggregated patch compliance state for a patch group.

OnInit
./lib/actions/DescribePatchGroupState.js
OnStartup
-
OnClose
-

Attributes

-

DescribePatchGroups

Lists all patch groups that have been registered with patch baselines.

OnInit
./lib/actions/DescribePatchGroups.js
OnStartup
-
OnClose
-

Attributes

-

DescribeSessions

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

OnInit
./lib/actions/DescribeSessions.js
OnStartup
-
OnClose
-

Attributes

-

GetAutomationExecution

Get detailed information about a particular Automation execution.

OnInit
./lib/actions/GetAutomationExecution.js
OnStartup
-
OnClose
-

Attributes

-

GetCommandInvocation

Returns detailed information about command execution for an invocation or plugin.

OnInit
./lib/actions/GetCommandInvocation.js
OnStartup
-
OnClose
-

Attributes

-

GetConnectionStatus

Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.

OnInit
./lib/actions/GetConnectionStatus.js
OnStartup
-
OnClose
-

Attributes

-

GetDefaultPatchBaseline

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.

If you do not specify an operating system value, the default patch baseline for Windows is returned.

OnInit
./lib/actions/GetDefaultPatchBaseline.js
OnStartup
-
OnClose
-

Attributes

-

GetDeployablePatchSnapshotForInstance

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.

OnInit
./lib/actions/GetDeployablePatchSnapshotForInstance.js
OnStartup
-
OnClose
-

Attributes

-

GetDocument

Gets the contents of the specified Systems Manager document.

OnInit
./lib/actions/GetDocument.js
OnStartup
-
OnClose
-

Attributes

-

GetInventory

Query inventory information.

OnInit
./lib/actions/GetInventory.js
OnStartup
-
OnClose
-

Attributes

-

GetInventorySchema

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

OnInit
./lib/actions/GetInventorySchema.js
OnStartup
-
OnClose
-

Attributes

-

GetMaintenanceWindow

Retrieves a Maintenance Window.

OnInit
./lib/actions/GetMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

GetMaintenanceWindowExecution

Retrieves details about a specific task executed as part of a Maintenance Window execution.

OnInit
./lib/actions/GetMaintenanceWindowExecution.js
OnStartup
-
OnClose
-

Attributes

-

GetMaintenanceWindowExecutionTask

Retrieves the details about a specific task executed as part of a Maintenance Window execution.

OnInit
./lib/actions/GetMaintenanceWindowExecutionTask.js
OnStartup
-
OnClose
-

Attributes

-

GetMaintenanceWindowExecutionTaskInvocation

Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.

OnInit
./lib/actions/GetMaintenanceWindowExecutionTaskInvocation.js
OnStartup
-
OnClose
-

Attributes

-

GetMaintenanceWindowTask

Lists the tasks in a Maintenance Window.

OnInit
./lib/actions/GetMaintenanceWindowTask.js
OnStartup
-
OnClose
-

Attributes

-

GetParameter

Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.

OnInit
./lib/actions/GetParameter.js
OnStartup
-
OnClose
-

Attributes

-

GetParameterHistory

Query a list of all parameters used by the AWS account.

OnInit
./lib/actions/GetParameterHistory.js
OnStartup
-
OnClose
-

Attributes

-

GetParameters

Get details of a parameter. Don't confuse this API action with the GetParameter API action.

OnInit
./lib/actions/GetParameters.js
OnStartup
-
OnClose
-

Attributes

-

GetParametersByPath

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

This API action doesn't support filtering by tags.

OnInit
./lib/actions/GetParametersByPath.js
OnStartup
-
OnClose
-

Attributes

-

GetPatchBaseline

Retrieves information about a patch baseline.

OnInit
./lib/actions/GetPatchBaseline.js
OnStartup
-
OnClose
-

Attributes

-

GetPatchBaselineForPatchGroup

Retrieves the patch baseline that should be used for the specified patch group.

OnInit
./lib/actions/GetPatchBaselineForPatchGroup.js
OnStartup
-
OnClose
-

Attributes

-

GetServiceSetting

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.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

Query the current service setting for the account.

OnInit
./lib/actions/GetServiceSetting.js
OnStartup
-
OnClose
-

Attributes

-

LabelParameterVersion

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.

Parameter labels have the following requirements and restrictions.

  • A version of a parameter can have a maximum of 10 labels.

  • You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

  • You can move a label from one version of a parameter to another.

  • You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

  • You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.

  • A label can have a maximum of 100 characters.

  • Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

  • Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.

OnInit
./lib/actions/LabelParameterVersion.js
OnStartup
-
OnClose
-

Attributes

-

ListAssociationVersions

Retrieves all versions of an association for a specific association ID.

OnInit
./lib/actions/ListAssociationVersions.js
OnStartup
-
OnClose
-

Attributes

-

ListAssociations

Lists the associations for the specified Systems Manager document or instance.

OnInit
./lib/actions/ListAssociations.js
OnStartup
-
OnClose
-

Attributes

-

ListCommandInvocations

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 executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

OnInit
./lib/actions/ListCommandInvocations.js
OnStartup
-
OnClose
-

Attributes

-

ListCommands

Lists the commands requested by users of the AWS account.

OnInit
./lib/actions/ListCommands.js
OnStartup
-
OnClose
-

Attributes

-

ListComplianceItems

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.

OnInit
./lib/actions/ListComplianceItems.js
OnStartup
-
OnClose
-

Attributes

-

ListComplianceSummaries

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.

OnInit
./lib/actions/ListComplianceSummaries.js
OnStartup
-
OnClose
-

Attributes

-

ListDocumentVersions

List all versions for a document.

OnInit
./lib/actions/ListDocumentVersions.js
OnStartup
-
OnClose
-

Attributes

-

ListDocuments

Describes one or more of your Systems Manager documents.

OnInit
./lib/actions/ListDocuments.js
OnStartup
-
OnClose
-

Attributes

-

ListInventoryEntries

A list of inventory items returned by the request.

OnInit
./lib/actions/ListInventoryEntries.js
OnStartup
-
OnClose
-

Attributes

-

ListResourceComplianceSummaries

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.

OnInit
./lib/actions/ListResourceComplianceSummaries.js
OnStartup
-
OnClose
-

Attributes

-

ListResourceDataSync

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.

The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

OnInit
./lib/actions/ListResourceDataSync.js
OnStartup
-
OnClose
-

Attributes

-

ListTagsForResource

Returns a list of the tags assigned to the specified resource.

OnInit
./lib/actions/ListTagsForResource.js
OnStartup
-
OnClose
-

Attributes

-

ModifyDocumentPermission

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.

OnInit
./lib/actions/ModifyDocumentPermission.js
OnStartup
-
OnClose
-

Attributes

-

PutComplianceItems

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.

ComplianceType can be one of the following:

  • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

  • ExecutionType: Specify patch, association, or Custom:string.

  • ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.

  • Id: The patch, association, or custom compliance ID.

  • Title: A title.

  • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

  • Severity: A patch severity. For example, critical.

  • DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.

  • DocumentVersion: An SSM document version number. For example, 4.

  • Classification: A patch classification. For example, security updates.

  • PatchBaselineId: A patch baseline ID.

  • PatchSeverity: A patch severity. For example, Critical.

  • PatchState: A patch state. For example, InstancesWithFailedPatches.

  • PatchGroup: The name of a patch group.

  • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

OnInit
./lib/actions/PutComplianceItems.js
OnStartup
-
OnClose
-

Attributes

-

PutInventory

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.

OnInit
./lib/actions/PutInventory.js
OnStartup
-
OnClose
-

Attributes

-

PutParameter

Add a parameter to the system.

OnInit
./lib/actions/PutParameter.js
OnStartup
-
OnClose
-

Attributes

-

RegisterDefaultPatchBaseline

Defines the default patch baseline.

OnInit
./lib/actions/RegisterDefaultPatchBaseline.js
OnStartup
-
OnClose
-

Attributes

-

RegisterPatchBaselineForPatchGroup

Registers a patch baseline for a patch group.

OnInit
./lib/actions/RegisterPatchBaselineForPatchGroup.js
OnStartup
-
OnClose
-

Attributes

-

RegisterTargetWithMaintenanceWindow

Registers a target with a Maintenance Window.

OnInit
./lib/actions/RegisterTargetWithMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

RegisterTaskWithMaintenanceWindow

Adds a new task to a Maintenance Window.

OnInit
./lib/actions/RegisterTaskWithMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

RemoveTagsFromResource

Removes all tags from the specified resource.

OnInit
./lib/actions/RemoveTagsFromResource.js
OnStartup
-
OnClose
-

Attributes

-

ResetServiceSetting

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.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting.

Reset the service setting for the account to the default value as provisioned by the AWS service team.

OnInit
./lib/actions/ResetServiceSetting.js
OnStartup
-
OnClose
-

Attributes

-

ResumeSession

Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.

OnInit
./lib/actions/ResumeSession.js
OnStartup
-
OnClose
-

Attributes

-

SendAutomationSignal

Sends a signal to an Automation execution to change the current behavior or status of the execution.

OnInit
./lib/actions/SendAutomationSignal.js
OnStartup
-
OnClose
-

Attributes

-

SendCommand

Executes commands on one or more managed instances.

OnInit
./lib/actions/SendCommand.js
OnStartup
-
OnClose
-

Attributes

-

StartAssociationsOnce

Use this API action to execute an association immediately and only one time. This action can be helpful when troubleshooting associations.

OnInit
./lib/actions/StartAssociationsOnce.js
OnStartup
-
OnClose
-

Attributes

-

StartAutomationExecution

Initiates execution of an Automation document.

OnInit
./lib/actions/StartAutomationExecution.js
OnStartup
-
OnClose
-

Attributes

-

StartSession

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.

AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.

OnInit
./lib/actions/StartSession.js
OnStartup
-
OnClose
-

Attributes

-

StopAutomationExecution

Stop an Automation that is currently executing.

OnInit
./lib/actions/StopAutomationExecution.js
OnStartup
-
OnClose
-

Attributes

-

TerminateSession

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.

OnInit
./lib/actions/TerminateSession.js
OnStartup
-
OnClose
-

Attributes

-

UpdateAssociation

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

OnInit
./lib/actions/UpdateAssociation.js
OnStartup
-
OnClose
-

Attributes

-

UpdateAssociationStatus

Updates the status of the Systems Manager document associated with the specified instance.

OnInit
./lib/actions/UpdateAssociationStatus.js
OnStartup
-
OnClose
-

Attributes

-

UpdateDocument

The document you want to update.

OnInit
./lib/actions/UpdateDocument.js
OnStartup
-
OnClose
-

Attributes

-

UpdateDocumentDefaultVersion

Set the default version of a document.

OnInit
./lib/actions/UpdateDocumentDefaultVersion.js
OnStartup
-
OnClose
-

Attributes

-

UpdateMaintenanceWindow

Updates an existing Maintenance Window. Only specified parameters are modified.

OnInit
./lib/actions/UpdateMaintenanceWindow.js
OnStartup
-
OnClose
-

Attributes

-

UpdateMaintenanceWindowTarget

Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following:

The target from being an ID target to a Tag target, or a Tag target to an ID target.

IDs for an ID target.

Tags for a Tag target.

Owner.

Name.

Description.

If a parameter is null, then the corresponding field is not modified.

OnInit
./lib/actions/UpdateMaintenanceWindowTarget.js
OnStartup
-
OnClose
-

Attributes

-

UpdateMaintenanceWindowTask

Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:

  • TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

  • ServiceRoleArn

  • TaskInvocationParameters

  • Priority

  • MaxConcurrency

  • MaxErrors

If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

OnInit
./lib/actions/UpdateMaintenanceWindowTask.js
OnStartup
-
OnClose
-

Attributes

-

UpdateManagedInstanceRole

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

OnInit
./lib/actions/UpdateManagedInstanceRole.js
OnStartup
-
OnClose
-

Attributes

-

UpdatePatchBaseline

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

OnInit
./lib/actions/UpdatePatchBaseline.js
OnStartup
-
OnClose
-

Attributes

-

UpdateServiceSetting

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.

Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

Update the service setting for the account.

OnInit
./lib/actions/UpdateServiceSetting.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment

You have any technical questions about the platform?

Technical documentation of the platform, online tutorials and more can be found here.

We are happy to bring you together directly with the flowground experts:

To contact form