AWS Systems Manager Connector

Latest Dynatrace

Review the required AWS permissions and condition keys of the AWS Systems Manager Connector actions to ensure that you grant Dynatrace only a minimum set of permissions. For more information, see AWS documentation.

Describe Automation executions

Provides details about all active and terminated Automation executions.

For more information, see the official documentation of Describe Automation executions.

Required AWS permission: ssm:DescribeAutomationExecutions.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
Filters
AutomationExecutionFilter[]
Filters used to limit the scope of executions that are requested.
optional

Output

Returns fields as described in DescribeAutomationExecutionsCommandOutput.

Describe document

Describes the specified Amazon Web Services Systems Manager document (SSM document).

For more information, see the official documentation of Describe document.

Required AWS permission: ssm:DescribeDocument.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
Name
string
The name of the SSM document.
required
DocumentVersion
string
The document version for which you want information.
optional
VersionName
string
An optional field specifying the version of the artifact associated with the document.
optional

Output

Returns fields as described in DescribeDocumentCommandOutput.

Get Automation execution

Get detailed information about a particular Automation execution.

For more information, see the official documentation of Get Automation execution.

Required AWS permission: ssm:GetAutomationExecution.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
AutomationExecutionId
string
The unique identifier for an existing automation execution to examine.
required

Output

Returns fields as described in GetAutomationExecutionCommandOutput.

Get document

Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).

For more information, see the official documentation of Get document.

Required AWS permission: ssm:GetDocument.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
Name
string
The name of the SSM document.
required
DocumentFormat
DocumentFormat
Returns the document in the specified format.
optional
DocumentVersion
string
The document version for which you want information.
optional
VersionName
string
An optional field specifying the version of the artifact associated with the document.
optional

Output

Returns fields as described in GetDocumentCommandOutput.

List commands

Lists the commands requested by users of the Amazon Web Services account.

For more information, see the official documentation of List commands.

Required AWS permission: ssm:ListCommands.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
CommandId
string
If provided, lists only the specified command.
optional
Filters
CommandFilter[]
One or more filters.
optional
InstanceId
string
Lists commands issued against this managed node ID.
optional
MaxResults
number
The maximum number of items to return for this call.
optional

Output

Returns fields as described in ListCommandsCommandOutput.

List documents

Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.

For more information, see the official documentation of List documents.

Required AWS permission: ssm:ListDocuments.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
Filters
DocumentKeyValuesFilter[]
One or more DocumentKeyValuesFilter objects.
optional
MaxResults
number
The maximum number of items to return for this call.
optional

Output

Returns fields as described in ListDocumentsCommandOutput.

Put parameter

Create or update a parameter in Parameter Store.

For more information, see the official documentation of Put parameter.

Required AWS permission: ssm:PutParameter.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
Name
string
The fully qualified name of the parameter that you want to create or update.
required
Value
string
The parameter value that you want to add to the system.
required
AllowedPattern
string
A regular expression used to validate the parameter value.
optional
DataType
string
The data type for a String parameter.
optional
Description
string
Information about the parameter that you want to add to the system.
optional
KeyId
string
The Key Management Service (KMS) ID that you want to use to encrypt a parameter.
optional
Overwrite
boolean
Overwrite an existing parameter.
optional
Policies
string
One or more policies to apply to a parameter.
optional
Tags
Tag[]
Optional metadata that you assign to a resource.
optional
Tier
ParameterTier
The parameter tier to assign to a parameter.
optional
Type
ParameterType
The type of parameter that you want to create.
optional

Output

Returns fields as described in PutParameterCommandOutput.

Send command

Runs commands on one or more managed nodes.

For more information, see the official documentation of Send command.

Required AWS permission: ssm:SendCommand.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
DocumentName
string
The name of the Amazon Web Services Systems Manager document (SSM document) to run.
required
InstanceIds
string[]
The IDs of the managed nodes where the command should run.
optional
MaxConcurrency
string
The maximum number of managed nodes allowed to run the command simultaneously.
optional
OutputS3BucketName
string
The name of the S3 bucket where command execution responses should be stored.
optional
OutputS3KeyPrefix
string
The directory structure within the S3 bucket where the responses should be stored.
optional
OutputS3Region
string
(Deprecated) You can no longer specify this parameter.
optional
Parameters
Record<string, string[]>
The required and optional parameters specified in the document being run.
optional
Targets
Target[]
An array of search criteria targeting managed nodes using a Key,Value combination you specify.
optional

Output

Returns fields as described in SendCommandCommandOutput.

Start Automation execution

Initiates execution of an Automation runbook.

For more information, see the official documentation of Start Automation execution.

Required AWS permission: ssm:StartAutomationExecution.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
DocumentName
string
The name of the SSM document to run.
required
AlarmConfiguration
AlarmConfiguration
The CloudWatch alarm you want to apply to your automation.
optional
ClientToken
string
User-provided idempotency token.
optional
DocumentVersion
string
The version of the Automation runbook to use for this execution.
optional
MaxConcurrency
string
The maximum number of targets allowed to run this task in parallel.
optional
MaxErrors
string
The number of errors that are allowed before the system stops running the automation on additional targets.
optional
Mode
ExecutionMode
The execution mode of the automation.
optional
Parameters
Record<string, string[]>
A key-value map of execution parameters, which match the declared parameters in the Automation runbook.
optional
Tags
Tag[]
Optional metadata that you assign to a resource.
optional
TargetLocations
TargetLocation[]
A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation.
optional
TargetLocationsURL
string
Specify a publicly accessible URL for a file that contains the TargetLocations body.
optional
TargetMaps
Record<string, string[]>[]
A key-value mapping of document parameters to target resources.
optional
TargetParameterName
string
The name of the parameter used as the target resource for the rate-controlled execution.
optional
Targets
Target[]
A key-value mapping to target resources.
optional

Output

Returns fields as described in StartAutomationExecutionCommandOutput.

Stop Automation execution

Stop an Automation that is currently running.

For more information, see the official documentation of Stop Automation execution.

Required AWS permission: ssm:StopAutomationExecution.

Inputs

Field
Type
Description
Required
Region
string
The region to use.
required
AutomationExecutionId
string
The execution ID of the Automation to stop.
required
Type
StopType
The stop request type.
optional

Output

Returns fields as described in StopAutomationExecutionCommandOutput.