package
0.0.0-20250304205905-b47799d07ddf
Repository: https://github.com/aws/amazon-ssm-agent.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

DocumentResultAggregator aggregates the result from the plugins to construct the agent response.
IsManagedInstanceIncompatibleAWSSSMDocument checks if doc could contain incompatible code for managed instance.
IsPreconditionEnabled checks if precondition support is enabled by checking document schema version.
MergeResultStatus takes two ResultStatuses (presumably from sub-tasks) and decides what the overall task status should be.
RemoveDependencyOnInstanceMetadata looks for array of commands which will be executed as a part of this document and replace the incompatible code.
UpdateDocState updates the current document state.

# Constants

Association represents document type for association.
AssociationErrorCodeExecutionError represents Execution Error.
NOTE: Following constants are meant to be used for setting error codes in plugin status only.
AssociationErrorCodeInvalidExpression represents InvalidExpression Error.
AssociationErrorCodeListAssociationError represents ListAssociation Error.
AssociationErrorCodeNoError represents no error.
AssociationErrorCodeStuckAtInProgressError represents association stuck in InProgress Error.
AssociationErrorCodeSubmitAssociationError represents SubmitAssociation Error.
DocumentInProgressMessage represents the summary message for inprogress association.
DocumentPendingMessages represents the summary message for pending association.
AssociationStatusAssociated represents Associated status.
AssociationStatusFailed represents Failed status.
AssociationStatusInProgress represents InProgress status.
NOTE: Following constants are meant to be used for setting plugin status only */ AssociationStatusPending represents Pending status.
AssociationStatusSuccess represents Success status.
AssociationStatusTimedOut represents TimedOut status.
CancelCommand represents document type for cancel command.
CancelCommandOffline represents document type for cancel command received from offline service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MessageDeliveryService represents messages that came from MDS.
MessageGatewayService represents messages that came from MGS.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ParamTypeString represents the Param Type is String.
ParamTypeStringList represents the Param Type is StringList.
ParamTypeStringMap represents the param type is StringMap.
ResultStatusCancelled represents Cancelled status.
ResultStatusFailed represents Failed status.
ResultStatusInProgress represents InProgress status.
ResultStatusNotStarted represents NotStarted status.
ResultStatusPassedAndReboot represents PassedAndReboot status.
ResultStatusSkipped represents Skipped status.
ResultStatusSuccess represents Success status.
ResultStatusSuccessAndReboot represents SuccessAndReboot status.
ResultStatusTestFailure represents test failure.
ResultStatusTestPass represents test passing.
ResultStatusTimedOut represents TimedOut status.
RunCommandResult represents result sent by document worker which ran runCommand documents.
SendCommand represents document type for send command.
SendCommandOffline represents document type for send command received from offline service.
SessionResult represents result sent by session worker to service.
StartSession represents document type for start session.
TerminateSession represents document type for terminate session.

# Structs

AdditionalInfo section in agent response.
AgentConfiguration is a struct that stores information about the agent and instance.
AgentInfo represents the agent response.
CancelCommandInfo represents information relevant to a cancel-command that agent receives TODO This might be revisited when Agent-cli is written to list previously executed commands.
CloudWatchConfiguration represents information relevant to command output in cloudWatch.
Configuration represents a plugin configuration as in the json format.
No description provided by the author
DocumentContent object which represents ssm document content.
DocumentInfo represents information stored as interim state for a document.
DocumentResult is a struct that stores information about the result of the document.
DocumentState represents information relevant to a command that gets executed by agent.
InstancePluginConfig stores plugin configuration.
IOConfiguration represents information relevant to the output sources of a command.
OSProcInfo represents information about the new process for outofproc.
A Parameter in the DocumentContent of an MDS message.
Plugin wraps the plugin configuration and plugin result.
PluginConfig stores plugin configuration.
PluginInput represents the input of the plugin.
PluginResult represents a plugin execution result.
PluginRuntimeStatus represents plugin runtime status section in agent response.
PluginState represents information stored as interim state for any plugin This has both the configuration with which a plugin gets executed and a corresponding plugin result.
PreconditionArgument represents a single input value for the plugin precondition operators InitialArgumentValue contains the original value of the argument as specified by the user (e.g.
SessionDocumentContent object which represents ssm session content.
SessionInputs stores session configuration.
ShellProfileConfig stores shell profile config.
StatusComm is a struct that holds channels to pass status between ssmAgentCore go routine and agent's main go routine.

# Interfaces

ICoreModule is the very much of core itself will be implemented as plugins that are simply hardcoded to run with agent framework.
ICoreModuleWrapper is the.
IPlugin is interface for authoring a functionality of work.
PluginOutputter defines interface for PluginOutput type.

# Type aliases

DocumentType defines the type of document persists locally.
IWorkerPlugin is the plugins which do not form part of core These plugins are invoked on demand.
ResultStatus provides the granular status of a plugin.
ResultType represents document Result types.
No description provided by the author
UpstreamServiceName defines which upstream service (MGS or MDS) the document request came from.