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.
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.
| 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 |
MaxResults | number | The maximum number of items to return for this call. | Optional |
NextToken | string | The token for the next set of items to return. | Optional |
Returns fields as described in DescribeAutomationExecutionsCommandOutput.
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.
| 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 |
Returns fields as described in DescribeDocumentCommandOutput.
Get detailed information about a particular Automation execution.
For more information, see the official documentation of Get Automation execution.
Required AWS permission: ssm:GetAutomationExecution.
| Field | Type | Description | Required |
|---|---|---|---|
Region | string | The region to use. | Required |
AutomationExecutionId | string | The unique identifier for an existing automation execution to examine. | Required |
Returns fields as described in GetAutomationExecutionCommandOutput.
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.
| 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 |
Returns fields as described in GetDocumentCommandOutput.
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.
| 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 |
NextToken | string | The token for the next set of items to return. | Optional |
Returns fields as described in ListCommandsCommandOutput.
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.
| Field | Type | Description | Required |
|---|---|---|---|
Region | string | The region to use. | Required |
Filters | DocumentKeyValuesFilter[] | One or more | Optional |
MaxResults | number | The maximum number of items to return for this call. | Optional |
NextToken | string | The token for the next set of items to return. | Optional |
Returns fields as described in ListDocumentsCommandOutput.
Create or update a parameter in Parameter Store.
For more information, see the official documentation of Put parameter.
Required AWS permission: ssm:PutParameter.
| 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 | 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 |
Returns fields as described in PutParameterCommandOutput.
Runs commands on one or more managed nodes.
For more information, see the official documentation of Send command.
Required AWS permission: ssm:SendCommand.
| 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 | Optional |
Returns fields as described in SendCommandCommandOutput.
Initiates execution of an Automation runbook.
For more information, see the official documentation of Start Automation execution.
Required AWS permission: ssm:StartAutomationExecution.
| 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 | 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 |
Returns fields as described in StartAutomationExecutionCommandOutput.
Stop an Automation that is currently running.
For more information, see the official documentation of Stop Automation execution.
Required AWS permission: ssm:StopAutomationExecution.
| 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 |
Returns fields as described in StopAutomationExecutionCommandOutput.