@datafire/amazonaws_ssm
v5.0.0
Published
DataFire integration for Amazon Simple Systems Manager (SSM)
Downloads
26
Readme
@datafire/amazonaws_ssm
Client library for Amazon Simple Systems Manager (SSM)
Installation and Usage
npm install --save @datafire/amazonaws_ssm
let amazonaws_ssm = require('@datafire/amazonaws_ssm').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_ssm.AddTagsToResource({
"ResourceType": "",
"ResourceId": "",
"Tags": []
}).then(data => {
console.log(data);
});
Description
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. 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.
Actions
AddTagsToResource
amazonaws_ssm.AddTagsToResource({
"ResourceType": "",
"ResourceId": "",
"Tags": []
}, context)
Input
- input
object
- ResourceId required ResourceId
- ResourceType required ResourceTypeForTagging
- Tags required TagList
Output
- output AddTagsToResourceResult
CancelCommand
amazonaws_ssm.CancelCommand({
"CommandId": ""
}, context)
Input
- input
object
- CommandId required CommandId
- InstanceIds InstanceIdList
Output
- output CancelCommandResult
CreateActivation
amazonaws_ssm.CreateActivation({
"IamRole": ""
}, context)
Input
- input
object
- DefaultInstanceName DefaultInstanceName
- Description ActivationDescription
- ExpirationDate ExpirationDate
- IamRole required IamRole
- RegistrationLimit RegistrationLimit
Output
- output CreateActivationResult
CreateAssociation
amazonaws_ssm.CreateAssociation({
"Name": ""
}, context)
Input
- input
object
- AssociationName AssociationName
- DocumentVersion DocumentVersion
- InstanceId InstanceId
- Name required DocumentName
- OutputLocation InstanceAssociationOutputLocation
- Parameters Parameters
- ScheduleExpression ScheduleExpression
- Targets Targets
Output
- output CreateAssociationResult
CreateAssociationBatch
amazonaws_ssm.CreateAssociationBatch({
"Entries": []
}, context)
Input
- input
object
- Entries required CreateAssociationBatchRequestEntries
Output
- output CreateAssociationBatchResult
CreateDocument
amazonaws_ssm.CreateDocument({
"Content": "",
"Name": ""
}, context)
Input
- input
object
- Content required DocumentContent
- DocumentFormat DocumentFormat
- DocumentType DocumentType
- Name required DocumentName
- TargetType TargetType
Output
- output CreateDocumentResult
CreateMaintenanceWindow
amazonaws_ssm.CreateMaintenanceWindow({
"Name": "",
"Schedule": "",
"Duration": 0,
"Cutoff": 0,
"AllowUnassociatedTargets": true
}, context)
Input
- input
object
- AllowUnassociatedTargets required MaintenanceWindowAllowUnassociatedTargets
- ClientToken ClientToken
- Cutoff required MaintenanceWindowCutoff
- Description MaintenanceWindowDescription
- Duration required MaintenanceWindowDurationHours
- Name required MaintenanceWindowName
- Schedule required MaintenanceWindowSchedule
Output
CreatePatchBaseline
amazonaws_ssm.CreatePatchBaseline({
"Name": ""
}, context)
Input
- input
object
- ApprovalRules PatchRuleGroup
- ApprovedPatches PatchIdList
- ApprovedPatchesComplianceLevel PatchComplianceLevel
- ApprovedPatchesEnableNonSecurity Boolean
- ClientToken ClientToken
- Description BaselineDescription
- GlobalFilters PatchFilterGroup
- Name required BaselineName
- OperatingSystem OperatingSystem
- RejectedPatches PatchIdList
- Sources PatchSourceList
Output
- output CreatePatchBaselineResult
CreateResourceDataSync
amazonaws_ssm.CreateResourceDataSync({
"SyncName": "",
"S3Destination": {
"BucketName": "",
"SyncFormat": "",
"Region": ""
}
}, context)
Input
- input
object
- S3Destination required ResourceDataSyncS3Destination
- SyncName required ResourceDataSyncName
Output
- output CreateResourceDataSyncResult
DeleteActivation
amazonaws_ssm.DeleteActivation({
"ActivationId": ""
}, context)
Input
- input
object
- ActivationId required ActivationId
Output
- output DeleteActivationResult
DeleteAssociation
amazonaws_ssm.DeleteAssociation({}, context)
Input
- input
object
- AssociationId AssociationId
- InstanceId InstanceId
- Name DocumentName
Output
- output DeleteAssociationResult
DeleteDocument
amazonaws_ssm.DeleteDocument({
"Name": ""
}, context)
Input
- input
object
- Name required DocumentName
Output
- output DeleteDocumentResult
DeleteMaintenanceWindow
amazonaws_ssm.DeleteMaintenanceWindow({
"WindowId": ""
}, context)
Input
- input
object
- WindowId required MaintenanceWindowId
Output
DeleteParameter
amazonaws_ssm.DeleteParameter({
"Name": ""
}, context)
Input
- input
object
- Name required PSParameterName
Output
- output DeleteParameterResult
DeleteParameters
amazonaws_ssm.DeleteParameters({
"Names": []
}, context)
Input
- input
object
- Names required ParameterNameList
Output
- output DeleteParametersResult
DeletePatchBaseline
amazonaws_ssm.DeletePatchBaseline({
"BaselineId": ""
}, context)
Input
- input
object
- BaselineId required BaselineId
Output
- output DeletePatchBaselineResult
DeleteResourceDataSync
amazonaws_ssm.DeleteResourceDataSync({
"SyncName": ""
}, context)
Input
- input
object
- SyncName required ResourceDataSyncName
Output
- output DeleteResourceDataSyncResult
DeregisterManagedInstance
amazonaws_ssm.DeregisterManagedInstance({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required ManagedInstanceId
Output
DeregisterPatchBaselineForPatchGroup
amazonaws_ssm.DeregisterPatchBaselineForPatchGroup({
"BaselineId": "",
"PatchGroup": ""
}, context)
Input
- input
object
- BaselineId required BaselineId
- PatchGroup required PatchGroup
Output
DeregisterTargetFromMaintenanceWindow
amazonaws_ssm.DeregisterTargetFromMaintenanceWindow({
"WindowId": "",
"WindowTargetId": ""
}, context)
Input
- input
object
- Safe Boolean
- WindowId required MaintenanceWindowId
- WindowTargetId required MaintenanceWindowTargetId
Output
DeregisterTaskFromMaintenanceWindow
amazonaws_ssm.DeregisterTaskFromMaintenanceWindow({
"WindowId": "",
"WindowTaskId": ""
}, context)
Input
- input
object
- WindowId required MaintenanceWindowId
- WindowTaskId required MaintenanceWindowTaskId
Output
DescribeActivations
amazonaws_ssm.DescribeActivations({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Filters DescribeActivationsFilterList
- MaxResults MaxResults
- NextToken NextToken
- MaxResults
Output
- output DescribeActivationsResult
DescribeAssociation
amazonaws_ssm.DescribeAssociation({}, context)
Input
- input
object
- AssociationId AssociationId
- AssociationVersion AssociationVersion
- InstanceId InstanceId
- Name DocumentName
Output
- output DescribeAssociationResult
DescribeAutomationExecutions
amazonaws_ssm.DescribeAutomationExecutions({}, context)
Input
- input
object
- Filters AutomationExecutionFilterList
- MaxResults MaxResults
- NextToken NextToken
Output
DescribeAutomationStepExecutions
amazonaws_ssm.DescribeAutomationStepExecutions({
"AutomationExecutionId": ""
}, context)
Input
- input
object
- AutomationExecutionId required AutomationExecutionId
- Filters StepExecutionFilterList
- MaxResults MaxResults
- NextToken NextToken
- ReverseOrder Boolean
Output
DescribeAvailablePatches
amazonaws_ssm.DescribeAvailablePatches({}, context)
Input
- input
object
- Filters PatchOrchestratorFilterList
- MaxResults PatchBaselineMaxResults
- NextToken NextToken
Output
DescribeDocument
amazonaws_ssm.DescribeDocument({
"Name": ""
}, context)
Input
- input
object
- DocumentVersion DocumentVersion
- Name required DocumentARN
Output
- output DescribeDocumentResult
DescribeDocumentPermission
amazonaws_ssm.DescribeDocumentPermission({
"Name": "",
"PermissionType": ""
}, context)
Input
- input
object
- Name required DocumentName
- PermissionType required DocumentPermissionType
Output
DescribeEffectiveInstanceAssociations
amazonaws_ssm.DescribeEffectiveInstanceAssociations({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required InstanceId
- MaxResults EffectiveInstanceAssociationMaxResults
- NextToken NextToken
Output
DescribeEffectivePatchesForPatchBaseline
amazonaws_ssm.DescribeEffectivePatchesForPatchBaseline({
"BaselineId": ""
}, context)
Input
- input
object
- BaselineId required BaselineId
- MaxResults PatchBaselineMaxResults
- NextToken NextToken
Output
DescribeInstanceAssociationsStatus
amazonaws_ssm.DescribeInstanceAssociationsStatus({
"InstanceId": ""
}, context)
Input
- input
object
- InstanceId required InstanceId
- MaxResults MaxResults
- NextToken NextToken
Output
DescribeInstanceInformation
amazonaws_ssm.DescribeInstanceInformation({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Filters InstanceInformationStringFilterList
- InstanceInformationFilterList InstanceInformationFilterList
- MaxResults MaxResultsEC2Compatible
- NextToken NextToken
- MaxResults
Output
DescribeInstancePatchStates
amazonaws_ssm.DescribeInstancePatchStates({
"InstanceIds": []
}, context)
Input
- input
object
- InstanceIds required InstanceIdList
- MaxResults PatchComplianceMaxResults
- NextToken NextToken
Output
DescribeInstancePatchStatesForPatchGroup
amazonaws_ssm.DescribeInstancePatchStatesForPatchGroup({
"PatchGroup": ""
}, context)
Input
- input
object
- Filters InstancePatchStateFilterList
- MaxResults PatchComplianceMaxResults
- NextToken NextToken
- PatchGroup required PatchGroup
Output
DescribeInstancePatches
amazonaws_ssm.DescribeInstancePatches({
"InstanceId": ""
}, context)
Input
- input
object
- Filters PatchOrchestratorFilterList
- InstanceId required InstanceId
- MaxResults PatchComplianceMaxResults
- NextToken NextToken
Output
DescribeMaintenanceWindowExecutionTaskInvocations
amazonaws_ssm.DescribeMaintenanceWindowExecutionTaskInvocations({
"WindowExecutionId": "",
"TaskId": ""
}, context)
Input
- input
object
- Filters MaintenanceWindowFilterList
- MaxResults MaintenanceWindowMaxResults
- NextToken NextToken
- TaskId required MaintenanceWindowExecutionTaskId
- WindowExecutionId required MaintenanceWindowExecutionId
Output
DescribeMaintenanceWindowExecutionTasks
amazonaws_ssm.DescribeMaintenanceWindowExecutionTasks({
"WindowExecutionId": ""
}, context)
Input
- input
object
- Filters MaintenanceWindowFilterList
- MaxResults MaintenanceWindowMaxResults
- NextToken NextToken
- WindowExecutionId required MaintenanceWindowExecutionId
Output
DescribeMaintenanceWindowExecutions
amazonaws_ssm.DescribeMaintenanceWindowExecutions({
"WindowId": ""
}, context)
Input
- input
object
- Filters MaintenanceWindowFilterList
- MaxResults MaintenanceWindowMaxResults
- NextToken NextToken
- WindowId required MaintenanceWindowId
Output
DescribeMaintenanceWindowTargets
amazonaws_ssm.DescribeMaintenanceWindowTargets({
"WindowId": ""
}, context)
Input
- input
object
- Filters MaintenanceWindowFilterList
- MaxResults MaintenanceWindowMaxResults
- NextToken NextToken
- WindowId required MaintenanceWindowId
Output
DescribeMaintenanceWindowTasks
amazonaws_ssm.DescribeMaintenanceWindowTasks({
"WindowId": ""
}, context)
Input
- input
object
- Filters MaintenanceWindowFilterList
- MaxResults MaintenanceWindowMaxResults
- NextToken NextToken
- WindowId required MaintenanceWindowId
Output
DescribeMaintenanceWindows
amazonaws_ssm.DescribeMaintenanceWindows({}, context)
Input
- input
object
- Filters MaintenanceWindowFilterList
- MaxResults MaintenanceWindowMaxResults
- NextToken NextToken
Output
DescribeParameters
amazonaws_ssm.DescribeParameters({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- Filters ParametersFilterList
- MaxResults MaxResults
- NextToken NextToken
- ParameterFilters ParameterStringFilterList
- MaxResults
Output
- output DescribeParametersResult
DescribePatchBaselines
amazonaws_ssm.DescribePatchBaselines({}, context)
Input
- input
object
- Filters PatchOrchestratorFilterList
- MaxResults PatchBaselineMaxResults
- NextToken NextToken
Output
- output DescribePatchBaselinesResult
DescribePatchGroupState
amazonaws_ssm.DescribePatchGroupState({
"PatchGroup": ""
}, context)
Input
- input
object
- PatchGroup required PatchGroup
Output
DescribePatchGroups
amazonaws_ssm.DescribePatchGroups({}, context)
Input
- input
object
- Filters PatchOrchestratorFilterList
- MaxResults PatchBaselineMaxResults
- NextToken NextToken
Output
- output DescribePatchGroupsResult
GetAutomationExecution
amazonaws_ssm.GetAutomationExecution({
"AutomationExecutionId": ""
}, context)
Input
- input
object
- AutomationExecutionId required AutomationExecutionId
Output
- output GetAutomationExecutionResult
GetCommandInvocation
amazonaws_ssm.GetCommandInvocation({
"CommandId": "",
"InstanceId": ""
}, context)
Input
- input
object
- CommandId required CommandId
- InstanceId required InstanceId
- PluginName CommandPluginName
Output
- output GetCommandInvocationResult
GetDefaultPatchBaseline
amazonaws_ssm.GetDefaultPatchBaseline({}, context)
Input
- input
object
- OperatingSystem OperatingSystem
Output
GetDeployablePatchSnapshotForInstance
amazonaws_ssm.GetDeployablePatchSnapshotForInstance({
"InstanceId": "",
"SnapshotId": ""
}, context)
Input
- input
object
- InstanceId required InstanceId
- SnapshotId required SnapshotId
Output
GetDocument
amazonaws_ssm.GetDocument({
"Name": ""
}, context)
Input
- input
object
- DocumentFormat DocumentFormat
- DocumentVersion DocumentVersion
- Name required DocumentARN
Output
- output GetDocumentResult
GetInventory
amazonaws_ssm.GetInventory({}, context)
Input
- input
object
- Aggregators InventoryAggregatorList
- Filters InventoryFilterList
- MaxResults MaxResults
- NextToken NextToken
- ResultAttributes ResultAttributeList
Output
- output GetInventoryResult
GetInventorySchema
amazonaws_ssm.GetInventorySchema({}, context)
Input
- input
object
- Aggregator AggregatorSchemaOnly
- MaxResults GetInventorySchemaMaxResults
- NextToken NextToken
- SubType IsSubTypeSchema
- TypeName InventoryItemTypeNameFilter
Output
- output GetInventorySchemaResult
GetMaintenanceWindow
amazonaws_ssm.GetMaintenanceWindow({
"WindowId": ""
}, context)
Input
- input
object
- WindowId required MaintenanceWindowId
Output
- output GetMaintenanceWindowResult
GetMaintenanceWindowExecution
amazonaws_ssm.GetMaintenanceWindowExecution({
"WindowExecutionId": ""
}, context)
Input
- input
object
- WindowExecutionId required MaintenanceWindowExecutionId
Output
GetMaintenanceWindowExecutionTask
amazonaws_ssm.GetMaintenanceWindowExecutionTask({
"WindowExecutionId": "",
"TaskId": ""
}, context)
Input
- input
object
- TaskId required MaintenanceWindowExecutionTaskId
- WindowExecutionId required MaintenanceWindowExecutionId
Output
GetMaintenanceWindowExecutionTaskInvocation
amazonaws_ssm.GetMaintenanceWindowExecutionTaskInvocation({
"WindowExecutionId": "",
"TaskId": "",
"InvocationId": ""
}, context)
Input
- input
object
- InvocationId required MaintenanceWindowExecutionTaskInvocationId
- TaskId required MaintenanceWindowExecutionTaskId
- WindowExecutionId required MaintenanceWindowExecutionId
Output
GetMaintenanceWindowTask
amazonaws_ssm.GetMaintenanceWindowTask({
"WindowId": "",
"WindowTaskId": ""
}, context)
Input
- input
object
- WindowId required MaintenanceWindowId
- WindowTaskId required MaintenanceWindowTaskId
Output
GetParameter
amazonaws_ssm.GetParameter({
"Name": ""
}, context)
Input
- input
object
- Name required PSParameterName
- WithDecryption Boolean
Output
- output GetParameterResult
GetParameterHistory
amazonaws_ssm.GetParameterHistory({
"Name": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults MaxResults
- Name required PSParameterName
- NextToken NextToken
- WithDecryption Boolean
- MaxResults
Output
- output GetParameterHistoryResult
GetParameters
amazonaws_ssm.GetParameters({
"Names": []
}, context)
Input
- input
object
- Names required ParameterNameList
- WithDecryption Boolean
Output
- output GetParametersResult
GetParametersByPath
amazonaws_ssm.GetParametersByPath({
"Path": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults GetParametersByPathMaxResults
- NextToken NextToken
- ParameterFilters ParameterStringFilterList
- Path required PSParameterName
- Recursive Boolean
- WithDecryption Boolean
- MaxResults
Output
- output GetParametersByPathResult
GetPatchBaseline
amazonaws_ssm.GetPatchBaseline({
"BaselineId": ""
}, context)
Input
- input
object
- BaselineId required BaselineId
Output
- output GetPatchBaselineResult
GetPatchBaselineForPatchGroup
amazonaws_ssm.GetPatchBaselineForPatchGroup({
"PatchGroup": ""
}, context)
Input
- input
object
- OperatingSystem OperatingSystem
- PatchGroup required PatchGroup
Output
ListAssociationVersions
amazonaws_ssm.ListAssociationVersions({
"AssociationId": ""
}, context)
Input
- input
object
- AssociationId required AssociationId
- MaxResults MaxResults
- NextToken NextToken
Output
ListAssociations
amazonaws_ssm.ListAssociations({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- AssociationFilterList AssociationFilterList
- MaxResults MaxResults
- NextToken NextToken
- MaxResults
Output
- output ListAssociationsResult
ListCommandInvocations
amazonaws_ssm.ListCommandInvocations({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- CommandId CommandId
- Details Boolean
- Filters CommandFilterList
- InstanceId InstanceId
- MaxResults CommandMaxResults
- NextToken NextToken
- MaxResults
Output
- output ListCommandInvocationsResult
ListCommands
amazonaws_ssm.ListCommands({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- CommandId CommandId
- Filters CommandFilterList
- InstanceId InstanceId
- MaxResults CommandMaxResults
- NextToken NextToken
- MaxResults
Output
- output ListCommandsResult
ListComplianceItems
amazonaws_ssm.ListComplianceItems({}, context)
Input
- input
object
- Filters ComplianceStringFilterList
- MaxResults MaxResults
- NextToken NextToken
- ResourceIds ComplianceResourceIdList
- ResourceTypes ComplianceResourceTypeList
Output
- output ListComplianceItemsResult
ListComplianceSummaries
amazonaws_ssm.ListComplianceSummaries({}, context)
Input
- input
object
- Filters ComplianceStringFilterList
- MaxResults MaxResults
- NextToken NextToken
Output
ListDocumentVersions
amazonaws_ssm.ListDocumentVersions({
"Name": ""
}, context)
Input
- input
object
- MaxResults MaxResults
- Name required DocumentName
- NextToken NextToken
Output
- output ListDocumentVersionsResult
ListDocuments
amazonaws_ssm.ListDocuments({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- DocumentFilterList DocumentFilterList
- Filters DocumentKeyValuesFilterList
- MaxResults MaxResults
- NextToken NextToken
- MaxResults
Output
- output ListDocumentsResult
ListInventoryEntries
amazonaws_ssm.ListInventoryEntries({
"InstanceId": "",
"TypeName": ""
}, context)
Input
- input
object
- Filters InventoryFilterList
- InstanceId required InstanceId
- MaxResults MaxResults
- NextToken NextToken
- TypeName required InventoryItemTypeName
Output
- output ListInventoryEntriesResult
ListResourceComplianceSummaries
amazonaws_ssm.ListResourceComplianceSummaries({}, context)
Input
- input
object
- Filters ComplianceStringFilterList
- MaxResults MaxResults
- NextToken NextToken
Output
ListResourceDataSync
amazonaws_ssm.ListResourceDataSync({}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
Output
- output ListResourceDataSyncResult
ListTagsForResource
amazonaws_ssm.ListTagsForResource({
"ResourceType": "",
"ResourceId": ""
}, context)
Input
- input
object
- ResourceId required ResourceId
- ResourceType required ResourceTypeForTagging
Output
- output ListTagsForResourceResult
ModifyDocumentPermission
amazonaws_ssm.ModifyDocumentPermission({
"Name": "",
"PermissionType": ""
}, context)
Input
- input
object
- AccountIdsToAdd AccountIdList
- AccountIdsToRemove AccountIdList
- Name required DocumentName
- PermissionType required DocumentPermissionType
Output
PutComplianceItems
amazonaws_ssm.PutComplianceItems({
"ResourceId": "",
"ResourceType": "",
"ComplianceType": "",
"ExecutionSummary": {
"ExecutionTime": ""
},
"Items": []
}, context)
Input
- input
object
- ComplianceType required ComplianceTypeName
- ExecutionSummary required ComplianceExecutionSummary
- ItemContentHash ComplianceItemContentHash
- Items required ComplianceItemEntryList
- ResourceId required ComplianceResourceId
- ResourceType required ComplianceResourceType
Output
- output PutComplianceItemsResult
PutInventory
amazonaws_ssm.PutInventory({
"InstanceId": "",
"Items": []
}, context)
Input
- input
object
- InstanceId required InstanceId
- Items required InventoryItemList
Output
- output PutInventoryResult
PutParameter
amazonaws_ssm.PutParameter({
"Name": "",
"Value": "",
"Type": ""
}, context)
Input
- input
object
- AllowedPattern AllowedPattern
- Description ParameterDescription
- KeyId ParameterKeyId
- Name required PSParameterName
- Overwrite Boolean
- Type required ParameterType
- Value required PSParameterValue
Output
- output PutParameterResult
RegisterDefaultPatchBaseline
amazonaws_ssm.RegisterDefaultPatchBaseline({
"BaselineId": ""
}, context)
Input
- input
object
- BaselineId required BaselineId
Output
RegisterPatchBaselineForPatchGroup
amazonaws_ssm.RegisterPatchBaselineForPatchGroup({
"BaselineId": "",
"PatchGroup": ""
}, context)
Input
- input
object
- BaselineId required BaselineId
- PatchGroup required PatchGroup
Output
RegisterTargetWithMaintenanceWindow
amazonaws_ssm.RegisterTargetWithMaintenanceWindow({
"WindowId": "",
"ResourceType": "",
"Targets": []
}, context)
Input
- input
object
- ClientToken ClientToken
- Description MaintenanceWindowDescription
- Name MaintenanceWindowName
- OwnerInformation OwnerInformation
- ResourceType required MaintenanceWindowResourceType
- Targets required Targets
- WindowId required MaintenanceWindowId
Output
RegisterTaskWithMaintenanceWindow
amazonaws_ssm.RegisterTaskWithMaintenanceWindow({
"WindowId": "",
"Targets": [],
"TaskArn": "",
"ServiceRoleArn": "",
"TaskType": "",
"MaxConcurrency": "",
"MaxErrors": ""
}, context)
Input
- input
object
- ClientToken ClientToken
- Description MaintenanceWindowDescription
- LoggingInfo LoggingInfo
- MaxConcurrency required MaxConcurrency
- MaxErrors required MaxErrors
- Name MaintenanceWindowName
- Priority MaintenanceWindowTaskPriority
- ServiceRoleArn required ServiceRole
- Targets required Targets
- TaskArn required MaintenanceWindowTaskArn
- TaskInvocationParameters MaintenanceWindowTaskInvocationParameters
- TaskParameters MaintenanceWindowTaskParameters
- TaskType required MaintenanceWindowTaskType
- WindowId required MaintenanceWindowId
Output
RemoveTagsFromResource
amazonaws_ssm.RemoveTagsFromResource({
"ResourceType": "",
"ResourceId": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceId required ResourceId
- ResourceType required ResourceTypeForTagging
- TagKeys required KeyList
Output
- output RemoveTagsFromResourceResult
SendAutomationSignal
amazonaws_ssm.SendAutomationSignal({
"AutomationExecutionId": "",
"SignalType": ""
}, context)
Input
- input
object
- AutomationExecutionId required AutomationExecutionId
- Payload AutomationParameterMap
- SignalType required SignalType
Output
- output SendAutomationSignalResult
SendCommand
amazonaws_ssm.SendCommand({
"DocumentName": ""
}, context)
Input
- input
object
- Comment Comment
- DocumentHash DocumentHash
- DocumentHashType DocumentHashType
- DocumentName required DocumentARN
- InstanceIds InstanceIdList
- MaxConcurrency MaxConcurrency
- MaxErrors MaxErrors
- NotificationConfig NotificationConfig
- OutputS3BucketName S3BucketName
- OutputS3KeyPrefix S3KeyPrefix
- OutputS3Region S3Region
- Parameters Parameters
- ServiceRoleArn ServiceRole
- Targets Targets
- TimeoutSeconds TimeoutSeconds
Output
- output SendCommandResult
StartAutomationExecution
amazonaws_ssm.StartAutomationExecution({
"DocumentName": ""
}, context)
Input
- input
object
- ClientToken IdempotencyToken
- DocumentName required DocumentARN
- DocumentVersion DocumentVersion
- MaxConcurrency MaxConcurrency
- MaxErrors MaxErrors
- Mode ExecutionMode
- Parameters AutomationParameterMap
- TargetParameterName AutomationParameterKey
- Targets Targets
Output
StopAutomationExecution
amazonaws_ssm.StopAutomationExecution({
"AutomationExecutionId": ""
}, context)
Input
- input
object
- AutomationExecutionId required AutomationExecutionId
- Type StopType
Output
UpdateAssociation
amazonaws_ssm.UpdateAssociation({
"AssociationId": ""
}, context)
Input
- input
object
- AssociationId required AssociationId
- AssociationName AssociationName
- AssociationVersion AssociationVersion
- DocumentVersion DocumentVersion
- Name DocumentName
- OutputLocation InstanceAssociationOutputLocation
- Parameters Parameters
- ScheduleExpression ScheduleExpression
- Targets Targets
Output
- output UpdateAssociationResult
UpdateAssociationStatus
amazonaws_ssm.UpdateAssociationStatus({
"Name": "",
"InstanceId": "",
"AssociationStatus": {
"Date": "",
"Name": "",
"Message": ""
}
}, context)
Input
- input
object
- AssociationStatus required AssociationStatus
- InstanceId required InstanceId
- Name required DocumentName
Output
UpdateDocument
amazonaws_ssm.UpdateDocument({
"Content": "",
"Name": ""
}, context)
Input
- input
object
- Content required DocumentContent
- DocumentFormat DocumentFormat
- DocumentVersion DocumentVersion
- Name required DocumentName
- TargetType TargetType
Output
- output UpdateDocumentResult
UpdateDocumentDefaultVersion
amazonaws_ssm.UpdateDocumentDefaultVersion({
"Name": "",
"DocumentVersion": ""
}, context)
Input
- input
object
- DocumentVersion required DocumentVersionNumber
- Name required DocumentName
Output
UpdateMaintenanceWindow
amazonaws_ssm.UpdateMaintenanceWindow({
"WindowId": ""
}, context)
Input
- input
object
- AllowUnassociatedTargets MaintenanceWindowAllowUnassociatedTargets
- Cutoff MaintenanceWindowCutoff
- Description MaintenanceWindowDescription
- Duration MaintenanceWindowDurationHours
- Enabled MaintenanceWindowEnabled
- Name MaintenanceWindowName
- Replace Boolean
- Schedule MaintenanceWindowSchedule
- WindowId required MaintenanceWindowId
Output
UpdateMaintenanceWindowTarget
amazonaws_ssm.UpdateMaintenanceWindowTarget({
"WindowId": "",
"WindowTargetId": ""
}, context)
Input
- input
object
- Description MaintenanceWindowDescription
- Name MaintenanceWindowName
- OwnerInformation OwnerInformation
- Replace Boolean
- Targets Targets
- WindowId required MaintenanceWindowId
- WindowTargetId required MaintenanceWindowTargetId
Output
UpdateMaintenanceWindowTask
amazonaws_ssm.UpdateMaintenanceWindowTask({
"WindowId": "",
"WindowTaskId": ""
}, context)
Input
- input
object
- Description MaintenanceWindowDescription
- LoggingInfo LoggingInfo
- MaxConcurrency MaxConcurrency
- MaxErrors MaxErrors
- Name MaintenanceWindowName
- Priority MaintenanceWindowTaskPriority
- Replace Boolean
- ServiceRoleArn ServiceRole
- Targets Targets
- TaskArn MaintenanceWindowTaskArn
- TaskInvocationParameters MaintenanceWindowTaskInvocationParameters
- TaskParameters MaintenanceWindowTaskParameters
- WindowId required MaintenanceWindowId
- WindowTaskId required MaintenanceWindowTaskId
Output
UpdateManagedInstanceRole
amazonaws_ssm.UpdateManagedInstanceRole({
"InstanceId": "",
"IamRole": ""
}, context)
Input
- input
object
- IamRole required IamRole
- InstanceId required ManagedInstanceId
Output
UpdatePatchBaseline
amazonaws_ssm.UpdatePatchBaseline({
"BaselineId": ""
}, context)
Input
- input
object
- ApprovalRules PatchRuleGroup
- ApprovedPatches PatchIdList
- ApprovedPatchesComplianceLevel PatchComplianceLevel
- ApprovedPatchesEnableNonSecurity Boolean
- BaselineId required BaselineId
- Description BaselineDescription
- GlobalFilters PatchFilterGroup
- Name BaselineName
- RejectedPatches PatchIdList
- Replace Boolean
- Sources PatchSourceList
Output
- output UpdatePatchBaselineResult
Definitions
AccountId
- AccountId
string
AccountIdList
- AccountIdList
array
- items AccountId
Activation
- Activation
object
: An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.- ActivationId ActivationId
- CreatedDate CreatedDate
- DefaultInstanceName DefaultInstanceName
- Description ActivationDescription
- ExpirationDate ExpirationDate
- Expired Boolean
- IamRole IamRole
- RegistrationLimit RegistrationLimit
- RegistrationsCount RegistrationsCount
ActivationCode
- ActivationCode
string
ActivationDescription
- ActivationDescription
string
ActivationId
- ActivationId
string
ActivationList
- ActivationList
array
- items Activation
AddTagsToResourceRequest
- AddTagsToResourceRequest
object
- ResourceId required ResourceId
- ResourceType required ResourceTypeForTagging
- Tags required TagList
AddTagsToResourceResult
- AddTagsToResourceResult
object
AgentErrorCode
- AgentErrorCode
string
AggregatorSchemaOnly
- AggregatorSchemaOnly
boolean
AllowedPattern
- AllowedPattern
string
AlreadyExistsException
- AlreadyExistsException
object
: Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.- Message String
ApproveAfterDays
- ApproveAfterDays
integer
AssociatedInstances
- AssociatedInstances
object
: You must disassociate a document from all instances before you can delete it.
Association
- Association
object
: Describes an association of a Systems Manager document and an instance.- AssociationId AssociationId
- AssociationName AssociationName
- AssociationVersion AssociationVersion
- DocumentVersion DocumentVersion
- InstanceId InstanceId
- LastExecutionDate DateTime
- Name DocumentName
- Overview AssociationOverview
- ScheduleExpression ScheduleExpression
- Targets Targets
AssociationAlreadyExists
- AssociationAlreadyExists
object
: The specified association already exists.
AssociationDescription
- AssociationDescription
object
: Describes the parameters for a document.- AssociationId AssociationId
- AssociationName AssociationName
- AssociationVersion AssociationVersion
- Date DateTime
- DocumentVersion DocumentVersion
- InstanceId InstanceId
- LastExecutionDate DateTime
- LastSuccessfulExecutionDate DateTime
- LastUpdateAssociationDate DateTime
- Name DocumentName
- OutputLocation InstanceAssociationOutputLocation
- Overview AssociationOverview
- Parameters Parameters
- ScheduleExpression ScheduleExpression
- Status AssociationStatus
- Targets Targets
AssociationDescriptionList
- AssociationDescriptionList
array
- items AssociationDescription
AssociationDoesNotExist
- AssociationDoesNotExist
object
: The specified association does not exist.- Message String
AssociationFilter
- AssociationFilter
object
: Describes a filter.- key required AssociationFilterKey
- value required AssociationFilterValue
AssociationFilterKey
- AssociationFilterKey
string
(values: InstanceId, Name, AssociationId, AssociationStatusName, LastExecutedBefore, LastExecutedAfter, AssociationName)
AssociationFilterList
- AssociationFilterList
array
- items AssociationFilter
AssociationFilterValue
- AssociationFilterValue
string
AssociationId
- AssociationId
string
AssociationLimitExceeded
- AssociationLimitExceeded
object
: You can have at most 2,000 active associations.
AssociationList
- AssociationList
array
- items Association
AssociationName
- AssociationName
string
AssociationOverview
- AssociationOverview
object
: Information about the association.- AssociationStatusAggregatedCount AssociationStatusAggregatedCount
- DetailedStatus StatusName
- Status StatusName
AssociationStatus
- AssociationStatus
object
: Describes an association status.- AdditionalInfo StatusAdditionalInfo
- Date required DateTime
- Message required StatusMessage
- Name required AssociationStatusName
AssociationStatusAggregatedCount
- AssociationStatusAggregatedCount
array
- items
object
- key StatusName
- value InstanceCount
- items
AssociationStatusName
- AssociationStatusName
string
(values: Pending, Success, Failed)
AssociationVersion
- AssociationVersion
string
AssociationVersionInfo
- AssociationVersionInfo
object
: Information about the association version.- AssociationId AssociationId
- AssociationName AssociationName
- AssociationVersion AssociationVersion
- CreatedDate DateTime
- DocumentVersion DocumentVersion
- Name DocumentName
- OutputLocation InstanceAssociationOutputLocation
- Parameters Parameters
- ScheduleExpression ScheduleExpression
- Targets Targets
AssociationVersionLimitExceeded
- AssociationVersionLimitExceeded
object
: You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.- Message String
AssociationVersionList
- AssociationVersionList
array
- items AssociationVersionInfo
AttributeName
- AttributeName
string
AttributeValue
- AttributeValue
string
AutomationActionName
- AutomationActionName
string
AutomationDefinitionNotFoundException
- AutomationDefinitionNotFoundException
object
: An Automation document with the specified name could not be found.- Message String
AutomationDefinitionVersionNotFoundException
- AutomationDefinitionVersionNotFoundException
object
: An Automation document with the specified name and version could not be found.- Message String
AutomationExecution
- AutomationExecution
object
: Detailed information about the current state of an individual Automation execution.- AutomationExecutionId AutomationExecutionId
- AutomationExecutionStatus AutomationExecutionStatus
- CurrentAction String
- CurrentStepName String
- DocumentName DocumentName
- DocumentVersion DocumentVersion
- ExecutedBy String
- ExecutionEndTime DateTime
- ExecutionStartTime DateTime
- FailureMessage String
- MaxConcurrency MaxConcurrency
- MaxErrors MaxErrors
- Mode ExecutionMode
- Outputs AutomationParameterMap
- Parameters AutomationParameterMap
- ParentAutomationExecutionId AutomationExecutionId
- ResolvedTargets ResolvedTargets
- StepExecutions StepExecutionList
- StepExecutionsTruncated Boolean
- Target String
- TargetParameterName AutomationParameterKey
- Targets Targets
AutomationExecutionFilter
- AutomationExecutionFilter
object
: A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.- Key required AutomationExecutionFilterKey
- Values required AutomationExecutionFilterValueList
AutomationExecutionFilterKey
- AutomationExecutionFilterKey
string
(values: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter)
AutomationExecutionFilterList
- AutomationExecutionFilterList
array
AutomationExecutionFilterValue
- AutomationExecutionFilterValue
string
AutomationExecutionFilterValueList
- AutomationExecutionFilterValueList
array
AutomationExecutionId
- AutomationExecutionId
string
AutomationExecutionLimitExceededException
- AutomationExecutionLimitExceededException
object
: The number of simultaneously running Automation executions exceeded the allowable limit.- Message String
AutomationExecutionMetadata
- AutomationExecutionMetadata
object
: Details about a specific Automation execution.- AutomationExecutionId AutomationExecutionId
- AutomationExecutionStatus AutomationExecutionStatus
- CurrentAction String
- CurrentStepName String
- DocumentName DocumentName
- DocumentVersion DocumentVersion
- ExecutedBy String
- ExecutionEndTime DateTime
- ExecutionStartTime DateTime
- FailureMessage String
- LogFile String
- MaxConcurrency MaxConcurrency
- MaxErrors MaxErrors
- Mode ExecutionMode
- Outputs AutomationParameterMap
- ParentAutomationExecutionId AutomationExecutionId
- ResolvedTargets ResolvedTargets
- Target String
- TargetParameterName AutomationParameterKey
- Targets Targets
AutomationExecutionMetadataList
- AutomationExecutionMetadataList
array
AutomationExecutionNotFoundException
- AutomationExecutionNotFoundException
object
: There is no automation execution information for the requested automation execution ID.- Message String
AutomationExecutionStatus
- AutomationExecutionStatus
string
(values: Pending, InProgress, Waiting, Success, TimedOut, Cancelling, Cancelled, Failed)
AutomationParameterKey
- AutomationParameterKey
string
AutomationParameterMap
- AutomationParameterMap
array
- items
object
- items
AutomationParameterValue
- AutomationParameterValue
string
AutomationParameterValueList
- AutomationParameterValueList
array
- items AutomationParameterValue
AutomationStepNotFoundException
- AutomationStepNotFoundException
object
: The specified step name and execution ID don't exist. Verify the information and try again.- Message String
BaselineDescription
- BaselineDescription
string
BaselineId
- BaselineId
string
BaselineName
- BaselineName
string
BatchErrorMessage
- BatchErrorMessage
string
Boolean
- Boolean
boolean
CancelCommandRequest
- CancelCommandRequest
object
:- CommandId required CommandId
- InstanceIds InstanceIdList
CancelCommandResult
- CancelCommandResult
object
: Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.
ClientToken
- ClientToken
string
Command
- Command
object
: Describes a command request.- CommandId CommandId
- Comment Comment
- CompletedCount CompletedCount
- DocumentName DocumentName
- ErrorCount ErrorCount
- ExpiresAfter DateTime
- InstanceIds InstanceIdList
- MaxConcurrency MaxConcurrency
- MaxErrors MaxErrors
- NotificationConfig NotificationConfig
- OutputS3BucketName S3BucketName
- OutputS3KeyPrefix S3KeyPrefix
- OutputS3Region S3Region
- Parameters Parameters
- RequestedDateTime DateTime
- ServiceRole ServiceRole
- Status CommandStatus
- StatusDetails StatusDetails
- TargetCount TargetCount
- Targets Targets
CommandFilter
- CommandFilter
object
: Describes a command filter.- key required CommandFilterKey
- value required CommandFilterValue
CommandFilterKey
- CommandFilterKey
string
(values: InvokedAfter, InvokedBefore, Status)
CommandFilterList
- CommandFilterList
array
- items CommandFilter
CommandFilterValue
- CommandFilterValue
string
CommandId
- CommandId
string
CommandInvocation
- CommandInvocation
object
: 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. A command invocation returns status and detail information about a command you executed.- CommandId CommandId
- CommandPlugins CommandPluginList
- Comment Comment
- DocumentName DocumentName
- InstanceId InstanceId
- InstanceName InstanceTagName
- NotificationConfig NotificationConfig
- RequestedDateTime DateTime
- ServiceRole ServiceRole
- StandardErrorUrl Url
- StandardOutputUrl Url
- Status CommandInvocationStatus
- StatusDetails StatusDetails
- TraceOutput InvocationTraceOutput
CommandInvocationList
- CommandInvocationList
array
- items CommandInvocation
CommandInvocationStatus
- CommandInvocationStatus
string
(values: Pending, InProgress, Delayed, Success, Cancelled, TimedOut, Failed, Cancelling)
CommandList
- CommandList
array
- items Command
CommandMaxResults
- CommandMaxResults
integer
CommandPlugin
- CommandPlugin
object
: Describes plugin details.- Name CommandPluginName
- Output CommandPluginOutput
- OutputS3BucketName S3BucketName
- OutputS3KeyPrefix S3KeyPrefix
- OutputS3Region S3Region
- ResponseCode ResponseCode
- ResponseFinishDateTime DateTime
- ResponseStartDateTime DateTime
- StandardErrorUrl Url
- StandardOutputUrl Url
- Status CommandPluginStatus
- StatusDetails StatusDetails
CommandPluginList
- CommandPluginList
array
- items CommandPlugin
CommandPluginName
- CommandPluginName
string
CommandPluginOutput
- CommandPluginOutput
string
CommandPluginStatus
- CommandPluginStatus
string
(values: Pending, InProgress, Success, TimedOut, Cancelled, Failed)
CommandStatus
- CommandStatus
string
(values: Pending, InProgress, Success, Cancelled, Failed, TimedOut, Cancelling)
Comment
- Comment
string
CompletedCount
- CompletedCount
integer
ComplianceExecutionId
- ComplianceExecutionId
string
ComplianceExecutionSummary
- ComplianceExecutionSummary
object
: A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.- ExecutionId ComplianceExecutionId
- ExecutionTime required DateTime
- ExecutionType ComplianceExecutionType
ComplianceExecutionType
- ComplianceExecutionType
string
ComplianceFilterValue
- ComplianceFilterValue
string
ComplianceItem
- ComplianceItem
object
: Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, etc.- ComplianceType ComplianceTypeName
- Details ComplianceItemDetails
- ExecutionSummary ComplianceExecutionSummary
- Id ComplianceItemId
- ResourceId ComplianceResourceId
- ResourceType ComplianceResourceType
- Severity ComplianceSeverity
- Status ComplianceStatus
- Title ComplianceItemTitle
ComplianceItemContentHash
- ComplianceItemContentHash
string
ComplianceItemDetails
- ComplianceItemDetails
array
- items
object
- key AttributeName
- value AttributeValue
- items
ComplianceItemEntry
- ComplianceItemEntry
object
: Information about a compliance item.- Details ComplianceItemDetails
- Id ComplianceItemId
- Severity required [C