❤
npm
Sign UpSign In

@datafire/amazonaws_ssm

5.0.0 • Public • Published

@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

Output

CancelCommand

amazonaws_ssm.CancelCommand({
  "CommandId": ""
}, context)

Input

Output

CreateActivation

amazonaws_ssm.CreateActivation({
  "IamRole": ""
}, context)

Input

Output

CreateAssociation

amazonaws_ssm.CreateAssociation({
  "Name": ""
}, context)

Input

Output

CreateAssociationBatch

amazonaws_ssm.CreateAssociationBatch({
  "Entries": []
}, context)

Input

Output

CreateDocument

amazonaws_ssm.CreateDocument({
  "Content": "",
  "Name": ""
}, context)

Input

Output

CreateMaintenanceWindow

amazonaws_ssm.CreateMaintenanceWindow({
  "Name": "",
  "Schedule": "",
  "Duration": 0,
  "Cutoff": 0,
  "AllowUnassociatedTargets": true
}, context)

Input

Output

CreatePatchBaseline

amazonaws_ssm.CreatePatchBaseline({
  "Name": ""
}, context)

Input

Output

CreateResourceDataSync

amazonaws_ssm.CreateResourceDataSync({
  "SyncName": "",
  "S3Destination": {
    "BucketName": "",
    "SyncFormat": "",
    "Region": ""
  }
}, context)

Input

Output

DeleteActivation

amazonaws_ssm.DeleteActivation({
  "ActivationId": ""
}, context)

Input

Output

DeleteAssociation

amazonaws_ssm.DeleteAssociation({}, context)

Input

Output

DeleteDocument

amazonaws_ssm.DeleteDocument({
  "Name": ""
}, context)

Input

Output

DeleteMaintenanceWindow

amazonaws_ssm.DeleteMaintenanceWindow({
  "WindowId": ""
}, context)

Input

Output

DeleteParameter

amazonaws_ssm.DeleteParameter({
  "Name": ""
}, context)

Input

Output

DeleteParameters

amazonaws_ssm.DeleteParameters({
  "Names": []
}, context)

Input

Output

DeletePatchBaseline

amazonaws_ssm.DeletePatchBaseline({
  "BaselineId": ""
}, context)

Input

Output

DeleteResourceDataSync

amazonaws_ssm.DeleteResourceDataSync({
  "SyncName": ""
}, context)

Input

Output

DeregisterManagedInstance

amazonaws_ssm.DeregisterManagedInstance({
  "InstanceId": ""
}, context)

Input

Output

DeregisterPatchBaselineForPatchGroup

amazonaws_ssm.DeregisterPatchBaselineForPatchGroup({
  "BaselineId": "",
  "PatchGroup": ""
}, context)

Input

Output

DeregisterTargetFromMaintenanceWindow

amazonaws_ssm.DeregisterTargetFromMaintenanceWindow({
  "WindowId": "",
  "WindowTargetId": ""
}, context)

Input

Output

DeregisterTaskFromMaintenanceWindow

amazonaws_ssm.DeregisterTaskFromMaintenanceWindow({
  "WindowId": "",
  "WindowTaskId": ""
}, context)

Input

Output

DescribeActivations

amazonaws_ssm.DescribeActivations({}, context)

Input

Output

DescribeAssociation

amazonaws_ssm.DescribeAssociation({}, context)

Input

Output

DescribeAutomationExecutions

amazonaws_ssm.DescribeAutomationExecutions({}, context)

Input

Output

DescribeAutomationStepExecutions

amazonaws_ssm.DescribeAutomationStepExecutions({
  "AutomationExecutionId": ""
}, context)

Input

Output

DescribeAvailablePatches

amazonaws_ssm.DescribeAvailablePatches({}, context)

Input

Output

DescribeDocument

amazonaws_ssm.DescribeDocument({
  "Name": ""
}, context)

Input

Output

DescribeDocumentPermission

amazonaws_ssm.DescribeDocumentPermission({
  "Name": "",
  "PermissionType": ""
}, context)

Input

Output

DescribeEffectiveInstanceAssociations

amazonaws_ssm.DescribeEffectiveInstanceAssociations({
  "InstanceId": ""
}, context)

Input

Output

DescribeEffectivePatchesForPatchBaseline

amazonaws_ssm.DescribeEffectivePatchesForPatchBaseline({
  "BaselineId": ""
}, context)

Input

Output

DescribeInstanceAssociationsStatus

amazonaws_ssm.DescribeInstanceAssociationsStatus({
  "InstanceId": ""
}, context)

Input

Output

DescribeInstanceInformation

amazonaws_ssm.DescribeInstanceInformation({}, context)

Input

Output

DescribeInstancePatchStates

amazonaws_ssm.DescribeInstancePatchStates({
  "InstanceIds": []
}, context)

Input

Output

DescribeInstancePatchStatesForPatchGroup

amazonaws_ssm.DescribeInstancePatchStatesForPatchGroup({
  "PatchGroup": ""
}, context)

Input

Output

DescribeInstancePatches

amazonaws_ssm.DescribeInstancePatches({
  "InstanceId": ""
}, context)

Input

Output

DescribeMaintenanceWindowExecutionTaskInvocations

amazonaws_ssm.DescribeMaintenanceWindowExecutionTaskInvocations({
  "WindowExecutionId": "",
  "TaskId": ""
}, context)

Input

Output

DescribeMaintenanceWindowExecutionTasks

amazonaws_ssm.DescribeMaintenanceWindowExecutionTasks({
  "WindowExecutionId": ""
}, context)

Input

Output

DescribeMaintenanceWindowExecutions

amazonaws_ssm.DescribeMaintenanceWindowExecutions({
  "WindowId": ""
}, context)

Input

Output

DescribeMaintenanceWindowTargets

amazonaws_ssm.DescribeMaintenanceWindowTargets({
  "WindowId": ""
}, context)

Input

Output

DescribeMaintenanceWindowTasks

amazonaws_ssm.DescribeMaintenanceWindowTasks({
  "WindowId": ""
}, context)

Input

Output

DescribeMaintenanceWindows

amazonaws_ssm.DescribeMaintenanceWindows({}, context)

Input

Output

DescribeParameters

amazonaws_ssm.DescribeParameters({}, context)

Input

Output

DescribePatchBaselines

amazonaws_ssm.DescribePatchBaselines({}, context)

Input

Output

DescribePatchGroupState

amazonaws_ssm.DescribePatchGroupState({
  "PatchGroup": ""
}, context)

Input

Output

DescribePatchGroups

amazonaws_ssm.DescribePatchGroups({}, context)

Input

Output

GetAutomationExecution

amazonaws_ssm.GetAutomationExecution({
  "AutomationExecutionId": ""
}, context)

Input

Output

GetCommandInvocation

amazonaws_ssm.GetCommandInvocation({
  "CommandId": "",
  "InstanceId": ""
}, context)

Input

Output

GetDefaultPatchBaseline

amazonaws_ssm.GetDefaultPatchBaseline({}, context)

Input

Output

GetDeployablePatchSnapshotForInstance

amazonaws_ssm.GetDeployablePatchSnapshotForInstance({
  "InstanceId": "",
  "SnapshotId": ""
}, context)

Input

Output

GetDocument

amazonaws_ssm.GetDocument({
  "Name": ""
}, context)

Input

Output

GetInventory

amazonaws_ssm.GetInventory({}, context)

Input

Output

GetInventorySchema

amazonaws_ssm.GetInventorySchema({}, context)

Input

Output

GetMaintenanceWindow

amazonaws_ssm.GetMaintenanceWindow({
  "WindowId": ""
}, context)

Input

Output

GetMaintenanceWindowExecution

amazonaws_ssm.GetMaintenanceWindowExecution({
  "WindowExecutionId": ""
}, context)

Input

Output

GetMaintenanceWindowExecutionTask

amazonaws_ssm.GetMaintenanceWindowExecutionTask({
  "WindowExecutionId": "",
  "TaskId": ""
}, context)

Input

Output

GetMaintenanceWindowExecutionTaskInvocation

amazonaws_ssm.GetMaintenanceWindowExecutionTaskInvocation({
  "WindowExecutionId": "",
  "TaskId": "",
  "InvocationId": ""
}, context)

Input

Output

GetMaintenanceWindowTask

amazonaws_ssm.GetMaintenanceWindowTask({
  "WindowId": "",
  "WindowTaskId": ""
}, context)

Input

Output

GetParameter

amazonaws_ssm.GetParameter({
  "Name": ""
}, context)

Input

Output

GetParameterHistory

amazonaws_ssm.GetParameterHistory({
  "Name": ""
}, context)

Input

Output

GetParameters

amazonaws_ssm.GetParameters({
  "Names": []
}, context)

Input

Output

GetParametersByPath

amazonaws_ssm.GetParametersByPath({
  "Path": ""
}, context)

Input

Output

GetPatchBaseline

amazonaws_ssm.GetPatchBaseline({
  "BaselineId": ""
}, context)

Input

Output

GetPatchBaselineForPatchGroup

amazonaws_ssm.GetPatchBaselineForPatchGroup({
  "PatchGroup": ""
}, context)

Input

Output

ListAssociationVersions

amazonaws_ssm.ListAssociationVersions({
  "AssociationId": ""
}, context)

Input

Output

ListAssociations

amazonaws_ssm.ListAssociations({}, context)

Input

Output

ListCommandInvocations

amazonaws_ssm.ListCommandInvocations({}, context)

Input

Output

ListCommands

amazonaws_ssm.ListCommands({}, context)

Input

Output

ListComplianceItems

amazonaws_ssm.ListComplianceItems({}, context)

Input

Output

ListComplianceSummaries

amazonaws_ssm.ListComplianceSummaries({}, context)

Input

Output

ListDocumentVersions

amazonaws_ssm.ListDocumentVersions({
  "Name": ""
}, context)

Input

Output

ListDocuments

amazonaws_ssm.ListDocuments({}, context)

Input

Output

ListInventoryEntries

amazonaws_ssm.ListInventoryEntries({
  "InstanceId": "",
  "TypeName": ""
}, context)

Input

Output

ListResourceComplianceSummaries

amazonaws_ssm.ListResourceComplianceSummaries({}, context)

Input

Output

ListResourceDataSync

amazonaws_ssm.ListResourceDataSync({}, context)

Input

Output

ListTagsForResource

amazonaws_ssm.ListTagsForResource({
  "ResourceType": "",
  "ResourceId": ""
}, context)

Input

Output

ModifyDocumentPermission

amazonaws_ssm.ModifyDocumentPermission({
  "Name": "",
  "PermissionType": ""
}, context)

Input

Output

PutComplianceItems

amazonaws_ssm.PutComplianceItems({
  "ResourceId": "",
  "ResourceType": "",
  "ComplianceType": "",
  "ExecutionSummary": {
    "ExecutionTime": ""
  },
  "Items": []
}, context)

Input

Output

PutInventory

amazonaws_ssm.PutInventory({
  "InstanceId": "",
  "Items": []
}, context)

Input

Output

PutParameter

amazonaws_ssm.PutParameter({
  "Name": "",
  "Value": "",
  "Type": ""
}, context)

Input

Output

RegisterDefaultPatchBaseline

amazonaws_ssm.RegisterDefaultPatchBaseline({
  "BaselineId": ""
}, context)

Input

Output

RegisterPatchBaselineForPatchGroup

amazonaws_ssm.RegisterPatchBaselineForPatchGroup({
  "BaselineId": "",
  "PatchGroup": ""
}, context)

Input

Output

RegisterTargetWithMaintenanceWindow

amazonaws_ssm.RegisterTargetWithMaintenanceWindow({
  "WindowId": "",
  "ResourceType": "",
  "Targets": []
}, context)

Input

Output

RegisterTaskWithMaintenanceWindow

amazonaws_ssm.RegisterTaskWithMaintenanceWindow({
  "WindowId": "",
  "Targets": [],
  "TaskArn": "",
  "ServiceRoleArn": "",
  "TaskType": "",
  "MaxConcurrency": "",
  "MaxErrors": ""
}, context)

Input

Output

RemoveTagsFromResource

amazonaws_ssm.RemoveTagsFromResource({
  "ResourceType": "",
  "ResourceId": "",
  "TagKeys": []
}, context)

Input

Output

SendAutomationSignal

amazonaws_ssm.SendAutomationSignal({
  "AutomationExecutionId": "",
  "SignalType": ""
}, context)

Input

Output

SendCommand

amazonaws_ssm.SendCommand({
  "DocumentName": ""
}, context)

Input

Output

StartAutomationExecution

amazonaws_ssm.StartAutomationExecution({
  "DocumentName": ""
}, context)

Input

Output

StopAutomationExecution

amazonaws_ssm.StopAutomationExecution({
  "AutomationExecutionId": ""
}, context)

Input

Output

UpdateAssociation

amazonaws_ssm.UpdateAssociation({
  "AssociationId": ""
}, context)

Input

Output

UpdateAssociationStatus

amazonaws_ssm.UpdateAssociationStatus({
  "Name": "",
  "InstanceId": "",
  "AssociationStatus": {
    "Date": "",
    "Name": "",
    "Message": ""
  }
}, context)

Input

Output

UpdateDocument

amazonaws_ssm.UpdateDocument({
  "Content": "",
  "Name": ""
}, context)

Input

Output

UpdateDocumentDefaultVersion

amazonaws_ssm.UpdateDocumentDefaultVersion({
  "Name": "",
  "DocumentVersion": ""
}, context)

Input

Output

UpdateMaintenanceWindow

amazonaws_ssm.UpdateMaintenanceWindow({
  "WindowId": ""
}, context)

Input

Output

UpdateMaintenanceWindowTarget

amazonaws_ssm.UpdateMaintenanceWindowTarget({
  "WindowId": "",
  "WindowTargetId": ""
}, context)

Input

Output

UpdateMaintenanceWindowTask

amazonaws_ssm.UpdateMaintenanceWindowTask({
  "WindowId": "",
  "WindowTaskId": ""
}, context)

Input

Output

UpdateManagedInstanceRole

amazonaws_ssm.UpdateManagedInstanceRole({
  "InstanceId": "",
  "IamRole": ""
}, context)

Input

Output

UpdatePatchBaseline

amazonaws_ssm.UpdatePatchBaseline({
  "BaselineId": ""
}, context)

Input

Output

Definitions

AccountId

  • AccountId string

AccountIdList

Activation

ActivationCode

  • ActivationCode string

ActivationDescription

  • ActivationDescription string

ActivationId

  • ActivationId string

ActivationList

AddTagsToResourceRequest

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.

ApproveAfterDays

  • ApproveAfterDays integer

AssociatedInstances

  • AssociatedInstances object: You must disassociate a document from all instances before you can delete it.

Association

AssociationAlreadyExists

  • AssociationAlreadyExists object: The specified association already exists.

AssociationDescription

AssociationDescriptionList

AssociationDoesNotExist

  • AssociationDoesNotExist object: The specified association does not exist.

AssociationFilter

AssociationFilterKey

  • AssociationFilterKey string (values: InstanceId, Name, AssociationId, AssociationStatusName, LastExecutedBefore, LastExecutedAfter, AssociationName)

AssociationFilterList

AssociationFilterValue

  • AssociationFilterValue string

AssociationId

  • AssociationId string

AssociationLimitExceeded

  • AssociationLimitExceeded object: You can have at most 2,000 active associations.

AssociationList

AssociationName

  • AssociationName string

AssociationOverview

AssociationStatus

AssociationStatusAggregatedCount

AssociationStatusName

  • AssociationStatusName string (values: Pending, Success, Failed)

AssociationVersion

  • AssociationVersion string

AssociationVersionInfo

AssociationVersionLimitExceeded

  • AssociationVersionLimitExceeded object: You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

AssociationVersionList

AttributeName

  • AttributeName string

AttributeValue

  • AttributeValue string

AutomationActionName

  • AutomationActionName string

AutomationDefinitionNotFoundException

  • AutomationDefinitionNotFoundException object: An Automation document with the specified name could not be found.

AutomationDefinitionVersionNotFoundException

  • AutomationDefinitionVersionNotFoundException object: An Automation document with the specified name and version could not be found.

AutomationExecution

AutomationExecutionFilter

AutomationExecutionFilterKey

  • AutomationExecutionFilterKey string (values: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter)

AutomationExecutionFilterList

AutomationExecutionFilterValue

  • AutomationExecutionFilterValue string

AutomationExecutionFilterValueList

AutomationExecutionId

  • AutomationExecutionId string

AutomationExecutionLimitExceededException

  • AutomationExecutionLimitExceededException object: The number of simultaneously running Automation executions exceeded the allowable limit.

AutomationExecutionMetadata

AutomationExecutionMetadataList

AutomationExecutionNotFoundException

  • AutomationExecutionNotFoundException object: There is no automation execution information for the requested automation execution ID.

AutomationExecutionStatus

  • AutomationExecutionStatus string (values: Pending, InProgress, Waiting, Success, TimedOut, Cancelling, Cancelled, Failed)

AutomationParameterKey

  • AutomationParameterKey string

AutomationParameterMap

AutomationParameterValue

  • AutomationParameterValue string

AutomationParameterValueList

AutomationStepNotFoundException

  • AutomationStepNotFoundException object: The specified step name and execution ID don't exist. Verify the information and try again.

BaselineDescription

  • BaselineDescription string

BaselineId

  • BaselineId string

BaselineName

  • BaselineName string

BatchErrorMessage

  • BatchErrorMessage string

Boolean

  • Boolean boolean

CancelCommandRequest

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

CommandFilter

CommandFilterKey

  • CommandFilterKey string (values: InvokedAfter, InvokedBefore, Status)

CommandFilterList

CommandFilterValue

  • CommandFilterValue string

CommandId

  • CommandId string

CommandInvocation

CommandInvocationList

CommandInvocationStatus

  • CommandInvocationStatus string (values: Pending, InProgress, Delayed, Success, Cancelled, TimedOut, Failed, Cancelling)

CommandList

CommandMaxResults

  • CommandMaxResults integer

CommandPlugin

CommandPluginList

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

ComplianceExecutionType

  • ComplianceExecutionType string

ComplianceFilterValue

  • ComplianceFilterValue string

ComplianceItem

ComplianceItemContentHash

  • ComplianceItemContentHash string

ComplianceItemDetails

ComplianceItemEntry

ComplianceItemEntryList

ComplianceItemId

  • ComplianceItemId string

ComplianceItemList

ComplianceItemTitle

  • ComplianceItemTitle string

ComplianceQueryOperatorType

  • ComplianceQueryOperatorType string (values: EQUAL, NOT_EQUAL, BEGIN_WITH, LESS_THAN, GREATER_THAN)

ComplianceResourceId

  • ComplianceResourceId string

ComplianceResourceIdList

ComplianceResourceType

  • ComplianceResourceType string

ComplianceResourceTypeList

ComplianceSeverity

  • ComplianceSeverity string (values: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED)

ComplianceStatus

  • ComplianceStatus string (values: COMPLIANT, NON_COMPLIANT)

ComplianceStringFilter

ComplianceStringFilterKey

  • ComplianceStringFilterKey string

ComplianceStringFilterList

ComplianceStringFilterValueList

ComplianceSummaryCount

  • ComplianceSummaryCount integer

ComplianceSummaryItem

ComplianceSummaryItemList

ComplianceTypeCountLimitExceededException

  • ComplianceTypeCountLimitExceededException object: You specified too many custom compliance types. You can specify a maximum of 10 different types.

ComplianceTypeName

  • ComplianceTypeName string

CompliantSummary

  • CompliantSummary object: A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.

ComputerName

  • ComputerName string

CreateActivationRequest

CreateActivationResult

CreateAssociationBatchRequest

CreateAssociationBatchRequestEntries

CreateAssociationBatchRequestEntry

CreateAssociationBatchResult

CreateAssociationRequest

CreateAssociationResult

CreateDocumentRequest

CreateDocumentResult

CreateMaintenanceWindowRequest

CreateMaintenanceWindowResult

CreatePatchBaselineRequest

CreatePatchBaselineResult

  • CreatePatchBaselineResult object

CreateResourceDataSyncRequest

CreateResourceDataSyncResult

  • CreateResourceDataSyncResult object

CreatedDate

  • CreatedDate string

CustomSchemaCountLimitExceededException

  • CustomSchemaCountLimitExceededException object: You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

DateTime

  • DateTime string

DefaultBaseline

  • DefaultBaseline boolean

DefaultInstanceName

  • DefaultInstanceName string

DeleteActivationRequest

  • DeleteActivationRequest object

DeleteActivationResult

  • DeleteActivationResult object

DeleteAssociationRequest

DeleteAssociationResult

  • DeleteAssociationResult object

DeleteDocumentRequest

DeleteDocumentResult

  • DeleteDocumentResult object

DeleteMaintenanceWindowRequest

DeleteMaintenanceWindowResult

DeleteParameterRequest

DeleteParameterResult

  • DeleteParameterResult object

DeleteParametersRequest

DeleteParametersResult

DeletePatchBaselineRequest

  • DeletePatchBaselineRequest object

DeletePatchBaselineResult

  • DeletePatchBaselineResult object

DeleteResourceDataSyncRequest

DeleteResourceDataSyncResult

  • DeleteResourceDataSyncResult object

DeregisterManagedInstanceRequest

DeregisterManagedInstanceResult

  • DeregisterManagedInstanceResult object

DeregisterPatchBaselineForPatchGroupRequest

  • DeregisterPatchBaselineForPatchGroupRequest object

DeregisterPatchBaselineForPatchGroupResult

DeregisterTargetFromMaintenanceWindowRequest

DeregisterTargetFromMaintenanceWindowResult

DeregisterTaskFromMaintenanceWindowRequest

DeregisterTaskFromMaintenanceWindowResult

DescribeActivationsFilter

DescribeActivationsFilterKeys

  • DescribeActivationsFilterKeys string (values: ActivationIds, DefaultInstanceName, IamRole)

DescribeActivationsFilterList

DescribeActivationsRequest

DescribeActivationsResult

DescribeAssociationRequest

DescribeAssociationResult

DescribeAutomationExecutionsRequest

DescribeAutomationExecutionsResult

DescribeAutomationStepExecutionsRequest

DescribeAutomationStepExecutionsResult

DescribeAvailablePatchesRequest

DescribeAvailablePatchesResult

DescribeDocumentPermissionRequest

DescribeDocumentPermissionResponse

  • DescribeDocumentPermissionResponse object

DescribeDocumentRequest

DescribeDocumentResult

DescribeEffectiveInstanceAssociationsRequest

DescribeEffectiveInstanceAssociationsResult

DescribeEffectivePatchesForPatchBaselineRequest

DescribeEffectivePatchesForPatchBaselineResult

DescribeInstanceAssociationsStatusRequest

DescribeInstanceAssociationsStatusResult

DescribeInstanceInformationRequest

DescribeInstanceInformationResult

DescribeInstancePatchStatesForPatchGroupRequest

DescribeInstancePatchStatesForPatchGroupResult

DescribeInstancePatchStatesRequest

DescribeInstancePatchStatesResult

DescribeInstancePatchesRequest

DescribeInstancePatchesResult

DescribeMaintenanceWindowExecutionTaskInvocationsRequest

DescribeMaintenanceWindowExecutionTaskInvocationsResult

DescribeMaintenanceWindowExecutionTasksRequest

DescribeMaintenanceWindowExecutionTasksResult

DescribeMaintenanceWindowExecutionsRequest

DescribeMaintenanceWindowExecutionsResult

DescribeMaintenanceWindowTargetsRequest

DescribeMaintenanceWindowTargetsResult

DescribeMaintenanceWindowTasksRequest

DescribeMaintenanceWindowTasksResult

DescribeMaintenanceWindowsRequest

DescribeMaintenanceWindowsResult

DescribeParametersRequest

DescribeParametersResult

DescribePatchBaselinesRequest

DescribePatchBaselinesResult

DescribePatchGroupStateRequest

  • DescribePatchGroupStateRequest object

DescribePatchGroupStateResult

  • DescribePatchGroupStateResult object
    • Instances Integer
    • InstancesWithFailedPatches Integer
    • InstancesWithInstalledOtherPatches Integer
    • InstancesWithInstalledPatches Integer
    • InstancesWithMissingPatches Integer
    • InstancesWithNotApplicablePatches Integer

DescribePatchGroupsRequest

DescribePatchGroupsResult

DescriptionInDocument

  • DescriptionInDocument string

DocumentARN

  • DocumentARN string

DocumentAlreadyExists

  • DocumentAlreadyExists object: The specified document already exists.

DocumentContent

  • DocumentContent string

DocumentDefaultVersionDescription

DocumentDescription

DocumentFilter

DocumentFilterKey

  • DocumentFilterKey string (values: Name, Owner, PlatformTypes, DocumentType)

DocumentFilterList

DocumentFilterValue

  • DocumentFilterValue string

DocumentFormat

  • DocumentFormat string (values: YAML, JSON)

DocumentHash

  • DocumentHash string

DocumentHashType

  • DocumentHashType string (values: Sha256, Sha1)

DocumentIdentifier

DocumentIdentifierList

DocumentKeyValuesFilter

  • DocumentKeyValuesFilter object:

    One or more filters. Use a filter to return a more specific list of documents.

    For keys, you can specify one or more tags that have been applied to a document.

    Other valid values include Owner, Name, PlatformTypes, and DocumentType.

    Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.

    If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the AWS CLI, to return a list of all documents that begin with Te, run the following command:

    aws ssm list-documents --filters Key=Name,Values=Te

    If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.

    To specify a custom key and value pair, use the format Key=tag:[tagName],Values=[valueName].

    For example, if you created a Key called region and are using the AWS CLI to call the list-documents command:

    aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self

DocumentKeyValuesFilterKey

  • DocumentKeyValuesFilterKey string

DocumentKeyValuesFilterList

DocumentKeyValuesFilterValue

  • DocumentKeyValuesFilterValue string

DocumentKeyValuesFilterValues

DocumentLimitExceeded

  • DocumentLimitExceeded object: You can have at most 200 active Systems Manager documents.

DocumentName

  • DocumentName string

DocumentOwner

  • DocumentOwner string

DocumentParameter

DocumentParameterDefaultValue

  • DocumentParameterDefaultValue string

DocumentParameterDescrption

  • DocumentParameterDescrption string

DocumentParameterList

DocumentParameterName

  • DocumentParameterName string

DocumentParameterType

  • DocumentParameterType string (values: String, StringList)

DocumentPermissionLimit

  • DocumentPermissionLimit object: The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.

DocumentPermissionType

  • DocumentPermissionType string (values: Share)

DocumentSchemaVersion

  • DocumentSchemaVersion string

DocumentSha1

  • DocumentSha1 string

DocumentStatus

  • DocumentStatus string (values: Creating, Active, Updating, Deleting)

DocumentType

  • DocumentType string (values: Command, Policy, Automation)

DocumentVersion

  • DocumentVersion string

DocumentVersionInfo

DocumentVersionLimitExceeded

  • DocumentVersionLimitExceeded object: The document has too many versions. Delete one or more document versions and try again.

DocumentVersionList

DocumentVersionNumber

  • DocumentVersionNumber string

DoesNotExistException

  • DoesNotExistException object:

    Error returned when the ID specified for a resource, such as a Maintenance Window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits.

DuplicateDocumentContent

  • DuplicateDocumentContent object: The content of the association document matches another document. Change the content of the document and try again.

DuplicateInstanceId

  • DuplicateInstanceId object: You cannot specify an instance ID in more than one association.

EffectiveInstanceAssociationMaxResults

  • EffectiveInstanceAssociationMaxResults integer

EffectivePatch

  • EffectivePatch object: The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

EffectivePatchList

ErrorCount

  • ErrorCount integer

ExecutionMode

  • ExecutionMode string (values: Auto, Interactive)

ExpirationDate

  • ExpirationDate string

FailedCreateAssociation

FailedCreateAssociationList

FailureDetails

Fault

  • Fault string (values: Client, Server, Unknown)

FeatureNotAvailableException

  • FeatureNotAvailableException object: You attempted to register a LAMBDA or STEP_FUNCTION task in a region where the corresponding service is not available.

GetAutomationExecutionRequest

GetAutomationExecutionResult

GetCommandInvocationRequest

GetCommandInvocationResult

GetDefaultPatchBaselineRequest

GetDefaultPatchBaselineResult

GetDeployablePatchSnapshotForInstanceRequest

  • GetDeployablePatchSnapshotForInstanceRequest object

GetDeployablePatchSnapshotForInstanceResult

GetDocumentRequest

GetDocumentResult

GetInventoryRequest

GetInventoryResult

GetInventorySchemaMaxResults

  • GetInventorySchemaMaxResults integer

GetInventorySchemaRequest

GetInventorySchemaResult

GetMaintenanceWindowExecutionRequest

GetMaintenanceWindowExecutionResult

GetMaintenanceWindowExecutionTaskInvocationRequest

GetMaintenanceWindowExecutionTaskInvocationResult

GetMaintenanceWindowExecutionTaskRequest

GetMaintenanceWindowExecutionTaskResult

GetMaintenanceWindowRequest

GetMaintenanceWindowResult

GetMaintenanceWindowTaskRequest

GetMaintenanceWindowTaskResult

GetParameterHistoryRequest

GetParameterHistoryResult

GetParameterRequest

GetParameterResult

  • GetParameterResult object

GetParametersByPathMaxResults

  • GetParametersByPathMaxResults integer

GetParametersByPathRequest

GetParametersByPathResult

GetParametersRequest

GetParametersResult

GetPatchBaselineForPatchGroupRequest

GetPatchBaselineForPatchGroupResult

GetPatchBaselineRequest

  • GetPatchBaselineRequest object

GetPatchBaselineResult

HierarchyLevelLimitExceededException

HierarchyTypeMismatchException

  • HierarchyTypeMismatchException object: Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.

IPAddress

  • IPAddress string

IamRole

  • IamRole string

IdempotencyToken

  • IdempotencyToken string

IdempotentParameterMismatch

  • IdempotentParameterMismatch object: Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

InstanceAggregatedAssociationOverview

InstanceAssociation

InstanceAssociationExecutionSummary

  • InstanceAssociationExecutionSummary string

InstanceAssociationList

InstanceAssociationOutputLocation

  • InstanceAssociationOutputLocation object: An Amazon S3 bucket where you want to store the results of this request.

InstanceAssociationOutputUrl

  • InstanceAssociationOutputUrl object: The URL of Amazon S3 bucket where you want to store the results of this request.

InstanceAssociationStatusAggregatedCount

InstanceAssociationStatusInfo

InstanceAssociationStatusInfos

InstanceCount

  • InstanceCount integer

InstanceId

  • InstanceId string

InstanceIdList

InstanceInformation

InstanceInformationFilter

InstanceInformationFilterKey

  • InstanceInformationFilterKey string (values: InstanceIds, AgentVersion, PingStatus, PlatformTypes, ActivationIds, IamRole, ResourceType, AssociationStatus)

InstanceInformationFilterList

InstanceInformationFilterValue

  • InstanceInformationFilterValue string

InstanceInformationFilterValueSet

InstanceInformationList

InstanceInformationStringFilter

InstanceInformationStringFilterKey

  • InstanceInformationStringFilterKey string

InstanceInformationStringFilterList

InstancePatchState

InstancePatchStateFilter

InstancePatchStateFilterKey

  • InstancePatchStateFilterKey string

InstancePatchStateFilterList

InstancePatchStateFilterValue

  • InstancePatchStateFilterValue string

InstancePatchStateFilterValues

InstancePatchStateList

InstancePatchStateOperatorType

  • InstancePatchStateOperatorType string (values: Equal, NotEqual, LessThan, GreaterThan)

InstancePatchStatesList

InstanceTagName

  • InstanceTagName string

Integer

  • Integer integer

InternalServerError

  • InternalServerError object: An error occurred on the server side.

InvalidActivation

  • InvalidActivation object: The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.

InvalidActivationId

  • InvalidActivationId object: The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.

InvalidAllowedPatternException

  • InvalidAllowedPatternException object: The request does not meet the regular expression requirement.

InvalidAssociationVersion

  • InvalidAssociationVersion object: The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.

InvalidAutomationExecutionParametersException

  • InvalidAutomationExecutionParametersException object: The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.

InvalidAutomationSignalException

  • InvalidAutomationSignalException object: The signal is not valid for the current Automation execution.

InvalidAutomationStatusUpdateException

  • InvalidAutomationStatusUpdateException object: The specified update status operation is not valid.

InvalidCommandId

  • InvalidCommandId object

InvalidDocument

  • InvalidDocument object: The specified document does not exist.

InvalidDocumentContent

  • InvalidDocumentContent object: The content for the document is not valid.

InvalidDocumentOperation

  • InvalidDocumentOperation object: You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

InvalidDocumentSchemaVersion

  • InvalidDocumentSchemaVersion object: The version of the document schema is not supported.

InvalidDocumentVersion

  • InvalidDocumentVersion object: The document version is not valid or does not exist.

InvalidFilter

  • InvalidFilter object: The filter name is not valid. Verify the you entered the correct name and try again.

InvalidFilterKey

  • InvalidFilterKey object: The specified key is not valid.

InvalidFilterOption

  • InvalidFilterOption object: The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

InvalidFilterValue

  • InvalidFilterValue object: The filter value is not valid. Verify the value and try again.

InvalidInstanceId

  • InvalidInstanceId object:

    The following problems can cause this exception:

    You do not have permission to access the instance.

    The SSM Agent is not running. On managed instances and Linux instances, verify that the SSM Agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

    The SSM Agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM Agent or EC2Config service.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

InvalidInstanceInformationFilterValue

  • InvalidInstanceInformationFilterValue object: The specified filter value is not valid.

InvalidInventoryItemContextException

  • InvalidInventoryItemContextException object: You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.

InvalidItemContentException

InvalidKeyId

  • InvalidKeyId object: The query key ID is not valid.

InvalidNextToken

  • InvalidNextToken object: The specified token is not valid.

InvalidNotificationConfig

  • InvalidNotificationConfig object: One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.

InvalidOutputFolder

  • InvalidOutputFolder object: The S3 bucket does not exist.

InvalidOutputLocation

  • InvalidOutputLocation object: The output location is not valid or does not exist.

InvalidParameters

  • InvalidParameters object: You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

InvalidPermissionType

  • InvalidPermissionType object: The permission type is not supported. Share is the only supported permission type.

InvalidPluginName

  • InvalidPluginName object: The plugin name is not valid.

InvalidResourceId

  • InvalidResourceId object: The resource ID is not valid. Verify that you entered the correct ID and try again.

InvalidResourceType

  • InvalidResourceType object: The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

InvalidResultAttributeException

  • InvalidResultAttributeException object: The specified inventory item result attribute is not valid.

InvalidRole

  • InvalidRole object: The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.

InvalidSchedule

  • InvalidSchedule object: The schedule is invalid. Verify your cron or rate expression and try again.

InvalidTarget

  • InvalidTarget object: The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

InvalidTypeNameException

  • InvalidTypeNameException object: The parameter type name is not valid.

InvalidUpdate

  • InvalidUpdate object: The update is not valid.

InventoryAggregator

InventoryAggregatorExpression

  • InventoryAggregatorExpression string

InventoryAggregatorList

InventoryAttributeDataType

  • InventoryAttributeDataType string (values: string, number)

InventoryFilter

InventoryFilterKey

  • InventoryFilterKey string

InventoryFilterList

InventoryFilterValue

  • InventoryFilterValue string

InventoryFilterValueList

InventoryItem

InventoryItemAttribute

InventoryItemAttributeList

InventoryItemAttributeName

  • InventoryItemAttributeName string

InventoryItemCaptureTime

  • InventoryItemCaptureTime string

InventoryItemContentContext

InventoryItemContentHash

  • InventoryItemContentHash string

InventoryItemEntry

InventoryItemEntryList

InventoryItemList

InventoryItemSchema

InventoryItemSchemaResultList

InventoryItemSchemaVersion

  • InventoryItemSchemaVersion string

InventoryItemTypeName

  • InventoryItemTypeName string

InventoryItemTypeNameFilter

  • InventoryItemTypeNameFilter string

InventoryQueryOperatorType

  • InventoryQueryOperatorType string (values: Equal, NotEqual, BeginWith, LessThan, GreaterThan)

InventoryResultEntity

InventoryResultEntityId

  • InventoryResultEntityId string

InventoryResultEntityList

InventoryResultItem

InventoryResultItemKey

  • InventoryResultItemKey string

InventoryResultItemMap

InventoryTypeDisplayName

  • InventoryTypeDisplayName string

InvocationDoesNotExist

  • InvocationDoesNotExist object: The command ID and instance ID you specified did not match any invocations. Verify the command ID adn the instance ID and try again.

InvocationTraceOutput

  • InvocationTraceOutput string

IsSubTypeSchema

  • IsSubTypeSchema boolean

ItemContentMismatchException

ItemSizeLimitExceededException

  • ItemSizeLimitExceededException object: The inventory item size has exceeded the size limit.

KeyList

LastResourceDataSyncStatus

  • LastResourceDataSyncStatus string (values: Successful, Failed, InProgress)

LastResourceDataSyncTime

  • LastResourceDataSyncTime string

LastSuccessfulResourceDataSyncTime

  • LastSuccessfulResourceDataSyncTime string

ListAssociationVersionsRequest

ListAssociationVersionsResult

ListAssociationsRequest

ListAssociationsResult

ListCommandInvocationsRequest

ListCommandInvocationsResult

ListCommandsRequest

ListCommandsResult

ListComplianceItemsRequest

ListComplianceItemsResult

ListComplianceSummariesRequest

ListComplianceSummariesResult

ListDocumentVersionsRequest

ListDocumentVersionsResult

ListDocumentsRequest

ListDocumentsResult

ListInventoryEntriesRequest

ListInventoryEntriesResult

ListResourceComplianceSummariesRequest

ListResourceComplianceSummariesResult

ListResourceDataSyncRequest

ListResourceDataSyncResult

ListTagsForResourceRequest

ListTagsForResourceResult

  • ListTagsForResourceResult object

LoggingInfo

  • LoggingInfo object: Information about an Amazon S3 bucket to write instance-level logs to.

Long

  • Long integer

MaintenanceWindowAllowUnassociatedTargets

  • MaintenanceWindowAllowUnassociatedTargets boolean

MaintenanceWindowAutomationParameters

MaintenanceWindowCutoff

  • MaintenanceWindowCutoff integer

MaintenanceWindowDescription

  • MaintenanceWindowDescription string

MaintenanceWindowDurationHours

  • MaintenanceWindowDurationHours integer

MaintenanceWindowEnabled

  • MaintenanceWindowEnabled boolean

MaintenanceWindowExecution

MaintenanceWindowExecutionId

  • MaintenanceWindowExecutionId string

MaintenanceWindowExecutionList

MaintenanceWindowExecutionStatus

  • MaintenanceWindowExecutionStatus string (values: PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, CANCELLED, SKIPPED_OVERLAPPING)

MaintenanceWindowExecutionStatusDetails

  • MaintenanceWindowExecutionStatusDetails string

MaintenanceWindowExecutionTaskExecutionId

  • MaintenanceWindowExecutionTaskExecutionId string

MaintenanceWindowExecutionTaskId

  • MaintenanceWindowExecutionTaskId string

MaintenanceWindowExecutionTaskIdList

MaintenanceWindowExecutionTaskIdentity

MaintenanceWindowExecutionTaskIdentityList

MaintenanceWindowExecutionTaskInvocationId

  • MaintenanceWindowExecutionTaskInvocationId string

MaintenanceWindowExecutionTaskInvocationIdentity

MaintenanceWindowExecutionTaskInvocationIdentityList

MaintenanceWindowExecutionTaskInvocationParameters

  • MaintenanceWindowExecutionTaskInvocationParameters string

MaintenanceWindowFilter

MaintenanceWindowFilterKey

  • MaintenanceWindowFilterKey string

MaintenanceWindowFilterList

MaintenanceWindowFilterValue

  • MaintenanceWindowFilterValue string

MaintenanceWindowFilterValues

MaintenanceWindowId

  • MaintenanceWindowId string

MaintenanceWindowIdentity

MaintenanceWindowIdentityList

MaintenanceWindowLambdaClientContext

  • MaintenanceWindowLambdaClientContext string

MaintenanceWindowLambdaParameters

MaintenanceWindowLambdaPayload

  • MaintenanceWindowLambdaPayload string

MaintenanceWindowLambdaQualifier

  • MaintenanceWindowLambdaQualifier string

MaintenanceWindowMaxResults

  • MaintenanceWindowMaxResults integer

MaintenanceWindowName

  • MaintenanceWindowName string

MaintenanceWindowResourceType

  • MaintenanceWindowResourceType string (values: INSTANCE)

MaintenanceWindowRunCommandParameters

MaintenanceWindowSchedule

  • MaintenanceWindowSchedule string

MaintenanceWindowStepFunctionsInput

  • MaintenanceWindowStepFunctionsInput string

MaintenanceWindowStepFunctionsName

  • MaintenanceWindowStepFunctionsName string

MaintenanceWindowStepFunctionsParameters

MaintenanceWindowTarget

MaintenanceWindowTargetId

  • MaintenanceWindowTargetId string

MaintenanceWindowTargetList

MaintenanceWindowTask

MaintenanceWindowTaskArn

  • MaintenanceWindowTaskArn string

MaintenanceWindowTaskId

  • MaintenanceWindowTaskId string

MaintenanceWindowTaskInvocationParameters

MaintenanceWindowTaskList

MaintenanceWindowTaskParameterName

  • MaintenanceWindowTaskParameterName string

MaintenanceWindowTaskParameterValue

  • MaintenanceWindowTaskParameterValue string

MaintenanceWindowTaskParameterValueExpression

MaintenanceWindowTaskParameterValueList

MaintenanceWindowTaskParameters

MaintenanceWindowTaskParametersList

MaintenanceWindowTaskPriority

  • MaintenanceWindowTaskPriority integer

MaintenanceWindowTaskTargetId

  • MaintenanceWindowTaskTargetId string

MaintenanceWindowTaskType

  • MaintenanceWindowTaskType string (values: RUN_COMMAND, AUTOMATION, STEP_FUNCTIONS, LAMBDA)

ManagedInstanceId

  • ManagedInstanceId string

MaxConcurrency

  • MaxConcurrency string

MaxDocumentSizeExceeded

  • MaxDocumentSizeExceeded object: The size limit of a document is 64 KB.

MaxErrors

  • MaxErrors string

MaxResults

  • MaxResults integer

MaxResultsEC2Compatible

  • MaxResultsEC2Compatible integer

ModifyDocumentPermissionRequest

ModifyDocumentPermissionResponse

  • ModifyDocumentPermissionResponse object

NextToken

  • NextToken string

NonCompliantSummary

  • NonCompliantSummary object: A summary of resources that are not compliant. The summary is organized according to resource type.

NormalStringMap

  • NormalStringMap array

NotificationArn

  • NotificationArn string

NotificationConfig

NotificationEvent

  • NotificationEvent string (values: All, InProgress, Success, TimedOut, Cancelled, Failed)

NotificationEventList

NotificationType

  • NotificationType string (values: Command, Invocation)

OperatingSystem

  • OperatingSystem string (values: WINDOWS, AMAZON_LINUX, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE)

OwnerInformation

  • OwnerInformation string

PSParameterName

  • PSParameterName string

PSParameterValue

  • PSParameterValue string

PSParameterVersion

  • PSParameterVersion integer

Parameter

ParameterAlreadyExists

  • ParameterAlreadyExists object: The parameter already exists. You can't create duplicate parameters.

ParameterDescription

  • ParameterDescription string

ParameterHistory

ParameterHistoryList

ParameterKeyId

  • ParameterKeyId string

ParameterLimitExceeded

  • ParameterLimitExceeded object: You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.

ParameterList

ParameterMaxVersionLimitExceeded

  • ParameterMaxVersionLimitExceeded object: The parameter exceeded the maximum number of allowed versions.

ParameterMetadata

ParameterMetadataList

ParameterName

  • ParameterName string

ParameterNameList

ParameterNotFound

  • ParameterNotFound object: The parameter could not be found. Verify the name and try again.

ParameterPatternMismatchException

  • ParameterPatternMismatchException object: The parameter name is not valid.

ParameterStringFilter

ParameterStringFilterKey

  • ParameterStringFilterKey string

ParameterStringFilterList

ParameterStringFilterValue

  • ParameterStringFilterValue string

ParameterStringFilterValueList

ParameterStringQueryOption

  • ParameterStringQueryOption string

ParameterType

  • ParameterType string (values: String, StringList, SecureString)

ParameterValue

  • ParameterValue string

ParameterValueList

ParameterVersionNotFound

  • ParameterVersionNotFound object: The specified parameter version was not found. Verify the parameter name and version, and try again.

Parameters

ParametersFilter

ParametersFilterKey

  • ParametersFilterKey string (values: Name, Type, KeyId)

ParametersFilterList

ParametersFilterValue

  • ParametersFilterValue string

ParametersFilterValueList

Patch

PatchBaselineIdentity

PatchBaselineIdentityList

PatchBaselineMaxResults

  • PatchBaselineMaxResults integer

PatchClassification

  • PatchClassification string

PatchComplianceData

PatchComplianceDataList

PatchComplianceDataState

  • PatchComplianceDataState string (values: INSTALLED, INSTALLED_OTHER, MISSING, NOT_APPLICABLE, FAILED)

PatchComplianceLevel

  • PatchComplianceLevel string (values: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED)

PatchComplianceMaxResults

  • PatchComplianceMaxResults integer

PatchContentUrl

  • PatchContentUrl string

PatchDeploymentStatus

  • PatchDeploymentStatus string (values: APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED)

PatchDescription

  • PatchDescription string

PatchFailedCount

  • PatchFailedCount integer

PatchFilter

  • PatchFilter object:

    Defines a patch filter.

    A patch filter consists of key/value pairs, but not all keys are valid for all operating system types. For example, the key PRODUCT is valid for all supported operating system types. The key MSRC_SEVERITY, however, is valid only for Windows operating systems, and the key SECTION is valid only for Ubuntu operating systems.

    Refer to the following sections for information about which keys may be used with each major operating system, and which values are valid for each key.

    Windows Operating Systems

    The supported keys for Windows operating systems are PRODUCT, CLASSIFICATION, and MSRC_SEVERITY. See the following lists for valid values for each of these keys.

    Supported key: PRODUCT

    Supported values:

    • Windows7

    • Windows8

    • Windows8.1

    • Windows8Embedded

    • Windows10

    • Windows10LTSB

    • WindowsServer2008

    • WindowsServer2008R2

    • WindowsServer2012

    • WindowsServer2012R2

    • WindowsServer2016

    Supported key: CLASSIFICATION

    Supported values:

    • CriticalUpdates

    • DefinitionUpdates

    • Drivers

    • FeaturePacks

    • SecurityUpdates

    • ServicePacks

    • Tools

    • UpdateRollups

    • Updates

    • Upgrades

    Supported key: MSRC_SEVERITY

    Supported values:

    • Critical

    • Important

    • Moderate

    • Low

    • Unspecified

    Ubuntu Operating Systems

    The supported keys for Ubuntu operating systems are PRODUCT, PRIORITY, and SECTION. See the following lists for valid values for each of these keys.

    Supported key: PRODUCT

    Supported values:

    • Ubuntu14.04

    • Ubuntu16.04

    Supported key: PRIORITY

    Supported values:

    • Required

    • Important

    • Standard

    • Optional

    • Extra

    Supported key: SECTION

    Only the length of the key value is validated. Minimum length is 1. Maximum length is 64.

    Amazon Linux Operating Systems

    The supported keys for Amazon Linux operating systems are PRODUCT, CLASSIFICATION, and SEVERITY. See the following lists for valid values for each of these keys.

    Supported key: PRODUCT

    Supported values:

    • AmazonLinux2012.03

    • AmazonLinux2012.09

    • AmazonLinux2013.03

    • AmazonLinux2013.09

    • AmazonLinux2014.03

    • AmazonLinux2014.09

    • AmazonLinux2015.03

    • AmazonLinux2015.09

    • AmazonLinux2016.03

    • AmazonLinux2016.09

    • AmazonLinux2017.03

    • AmazonLinux2017.09

    Supported key: CLASSIFICATION

    Supported values:

    • Security

    • Bugfix

    • Enhancement

    • Recommended

    • Newpackage

    Supported key: SEVERITY

    Supported values:

    • Critical

    • Important

    • Medium

    • Low

    RedHat Enterprise Linux (RHEL) Operating Systems

    The supported keys for RedHat Enterprise Linux operating systems are PRODUCT, CLASSIFICATION, and SEVERITY. See the following lists for valid values for each of these keys.

    Supported key: PRODUCT

    Supported values:

    • RedhatEnterpriseLinux6.5

    • RedhatEnterpriseLinux6.6

    • RedhatEnterpriseLinux6.7

    • RedhatEnterpriseLinux6.8

    • RedhatEnterpriseLinux6.9

    • RedhatEnterpriseLinux7.0

    • RedhatEnterpriseLinux7.1

    • RedhatEnterpriseLinux7.2

    • RedhatEnterpriseLinux7.3

    • RedhatEnterpriseLinux7.4

    Supported key: CLASSIFICATION

    Supported values:

    • Security

    • Bugfix

    • Enhancement

    • Recommended

    • Newpackage

    Supported key: SEVERITY

    Supported values:

    • Critical

    • Important

    • Medium

    • Low

    SUSE Linux Enterprise Server (SUSE) Operating Systems

    The supported keys for SUSE operating systems are PRODUCT, CLASSIFICATION, and SEVERITY. See the following lists for valid values for each of these keys.

    Supported key: PRODUCT

    Supported values:

    • Suse12.0

    • Suse12.1

    • Suse12.2

    • Suse12.3

    • Suse12.4

    • Suse12.5

    • Suse12.6

    • Suse12.7

    • Suse12.8

    • Suse12.9

    Supported key: CLASSIFICATION

    Supported values:

    • Security

    • Recommended

    • Optional

    • Feature

    • Document

    • Yast

    Supported key: SEVERITY

    Supported values:

    • Critical

    • Important

    • Moderate

    • Low

PatchFilterGroup

  • PatchFilterGroup object: A set of patch filters, typically used for approval rules.

PatchFilterKey

  • PatchFilterKey string (values: PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID, SECTION, PRIORITY, SEVERITY)

PatchFilterList

PatchFilterValue

  • PatchFilterValue string

PatchFilterValueList

PatchGroup

  • PatchGroup string

PatchGroupList

PatchGroupPatchBaselineMapping

  • PatchGroupPatchBaselineMapping object: The mapping between a patch group and the patch baseline the patch group is registered with.

PatchGroupPatchBaselineMappingList

PatchId

  • PatchId string

PatchIdList

PatchInstalledCount

  • PatchInstalledCount integer

PatchInstalledOtherCount

  • PatchInstalledOtherCount integer

PatchKbNumber

  • PatchKbNumber string

PatchLanguage

  • PatchLanguage string

PatchList

  • PatchList array

PatchMissingCount

  • PatchMissingCount integer

PatchMsrcNumber

  • PatchMsrcNumber string

PatchMsrcSeverity

  • PatchMsrcSeverity string

PatchNotApplicableCount

  • PatchNotApplicableCount integer

PatchOperationType

  • PatchOperationType string (values: Scan, Install)

PatchOrchestratorFilter

PatchOrchestratorFilterKey

  • PatchOrchestratorFilterKey string

PatchOrchestratorFilterList

PatchOrchestratorFilterValue

  • PatchOrchestratorFilterValue string

PatchOrchestratorFilterValues

PatchProduct

  • PatchProduct string

PatchProductFamily

  • PatchProductFamily string

PatchRule

PatchRuleGroup

  • PatchRuleGroup object: A set of rules defining the approval rules for a patch baseline.

PatchRuleList

PatchSeverity

  • PatchSeverity string

PatchSource

PatchSourceConfiguration

  • PatchSourceConfiguration string

PatchSourceList

PatchSourceName

  • PatchSourceName string

PatchSourceProduct

  • PatchSourceProduct string

PatchSourceProductList

PatchStatus

PatchTitle

  • PatchTitle string

PatchVendor

  • PatchVendor string

PingStatus

  • PingStatus string (values: Online, ConnectionLost, Inactive)

PlatformType

  • PlatformType string (values: Windows, Linux)

PlatformTypeList

Product

  • Product string

PutComplianceItemsRequest

PutComplianceItemsResult

  • PutComplianceItemsResult object

PutInventoryRequest

PutInventoryResult

  • PutInventoryResult object

PutParameterRequest

PutParameterResult

RegisterDefaultPatchBaselineRequest

  • RegisterDefaultPatchBaselineRequest object

RegisterDefaultPatchBaselineResult

  • RegisterDefaultPatchBaselineResult object

RegisterPatchBaselineForPatchGroupRequest

  • RegisterPatchBaselineForPatchGroupRequest object

RegisterPatchBaselineForPatchGroupResult

RegisterTargetWithMaintenanceWindowRequest

RegisterTargetWithMaintenanceWindowResult

RegisterTaskWithMaintenanceWindowRequest

RegisterTaskWithMaintenanceWindowResult

RegistrationLimit

  • RegistrationLimit integer

RegistrationsCount

  • RegistrationsCount integer

RemoveTagsFromResourceRequest

RemoveTagsFromResourceResult

  • RemoveTagsFromResourceResult object

ResolvedTargets

  • ResolvedTargets object: Information about targets that resolved during the Automation execution.

ResourceComplianceSummaryItem

ResourceComplianceSummaryItemList

ResourceDataSyncAWSKMSKeyARN

  • ResourceDataSyncAWSKMSKeyARN string

ResourceDataSyncAlreadyExistsException

  • ResourceDataSyncAlreadyExistsException object: A sync configuration with the same name already exists.

ResourceDataSyncCountExceededException

  • ResourceDataSyncCountExceededException object: You have exceeded the allowed maximum sync configurations.

ResourceDataSyncCreatedTime

  • ResourceDataSyncCreatedTime string

ResourceDataSyncInvalidConfigurationException

  • ResourceDataSyncInvalidConfigurationException object: The specified sync configuration is invalid.

ResourceDataSyncItem

ResourceDataSyncItemList

ResourceDataSyncName

  • ResourceDataSyncName string

ResourceDataSyncNotFoundException

  • ResourceDataSyncNotFoundException object: The specified sync name was not found.

ResourceDataSyncS3BucketName

  • ResourceDataSyncS3BucketName string

ResourceDataSyncS3Destination

ResourceDataSyncS3Format

  • ResourceDataSyncS3Format string (values: JsonSerDe)

ResourceDataSyncS3Prefix

  • ResourceDataSyncS3Prefix string

ResourceDataSyncS3Region

  • ResourceDataSyncS3Region string

ResourceId

  • ResourceId string

ResourceInUseException

  • ResourceInUseException object: Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.

ResourceLimitExceededException

  • ResourceLimitExceededException object:

    Error returned when the caller has exceeded the default resource limits. For example, too many Maintenance Windows or Patch baselines have been created.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits.

ResourceType

  • ResourceType string (values: ManagedInstance, Document, EC2Instance)

ResourceTypeForTagging

  • ResourceTypeForTagging string (values: Document, ManagedInstance, MaintenanceWindow, Parameter, PatchBaseline)

ResponseCode

  • ResponseCode integer

ResultAttribute

ResultAttributeList

S3BucketName

  • S3BucketName string

S3KeyPrefix

  • S3KeyPrefix string

S3OutputLocation

  • S3OutputLocation object: An Amazon S3 bucket where you want to store the results of this request.

S3OutputUrl

  • S3OutputUrl object: A URL for the Amazon S3 bucket where you want to store the results of this request.
    • OutputUrl Url

S3Region

  • S3Region string

ScheduleExpression

  • ScheduleExpression string

SendAutomationSignalRequest

SendAutomationSignalResult

  • SendAutomationSignalResult object

SendCommandRequest

SendCommandResult

  • SendCommandResult object

ServiceRole

  • ServiceRole string

SeveritySummary

SignalType

  • SignalType string (values: Approve, Reject, StartStep, StopStep, Resume)

SnapshotDownloadUrl

  • SnapshotDownloadUrl string

SnapshotId

  • SnapshotId string

StandardErrorContent

  • StandardErrorContent string

StandardOutputContent

  • StandardOutputContent string

StartAutomationExecutionRequest

StartAutomationExecutionResult

StatusAdditionalInfo

  • StatusAdditionalInfo string

StatusDetails

  • StatusDetails string

StatusMessage

  • StatusMessage string

StatusName

  • StatusName string

StatusUnchanged

  • StatusUnchanged object: The updated status is the same as the current status.

StepExecution

StepExecutionFilter

StepExecutionFilterKey

  • StepExecutionFilterKey string (values: StartTimeBefore, StartTimeAfter, StepExecutionStatus, StepExecutionId, StepName, Action)

StepExecutionFilterList

StepExecutionFilterValue

  • StepExecutionFilterValue string

StepExecutionFilterValueList

StepExecutionList

StopAutomationExecutionRequest

StopAutomationExecutionResult

  • StopAutomationExecutionResult object

StopType

  • StopType string (values: Complete, Cancel)

String

  • String string

StringDateTime

  • StringDateTime string

StringList

  • StringList array

SubTypeCountLimitExceededException

  • SubTypeCountLimitExceededException object: The sub-type count exceeded the limit for the inventory type.

Tag

  • Tag object: Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Systems Manager, you can apply tags to documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines.

TagKey

  • TagKey string

TagList

  • TagList array

TagValue

  • TagValue string

Target

  • Target object:

    An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

TargetCount

  • TargetCount integer

TargetInUseException

  • TargetInUseException object: You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

TargetKey

  • TargetKey string

TargetParameterList

TargetType

  • TargetType string

TargetValue

  • TargetValue string

TargetValues

Targets

TimeoutSeconds

  • TimeoutSeconds integer

TooManyTagsError

  • TooManyTagsError object: The Targets parameter includes too many tags. Remove one or more tags and try the command again.

TooManyUpdates

  • TooManyUpdates object: There are concurrent updates for a resource that supports one update at a time.

TotalSizeLimitExceededException

  • TotalSizeLimitExceededException object: The size of inventory data has exceeded the total size limit for the resource.

UnsupportedInventoryItemContextException

  • UnsupportedInventoryItemContextException object: The Context attribute that you specified for the InventoryItem is not allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.

UnsupportedInventorySchemaVersionException

  • UnsupportedInventorySchemaVersionException object: Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.

UnsupportedOperatingSystem

  • UnsupportedOperatingSystem object: The operating systems you specified is not supported, or the operation is not supported for the operating system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.

UnsupportedParameterType

  • UnsupportedParameterType object: The parameter type is not supported.

UnsupportedPlatformType

  • UnsupportedPlatformType object: The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

UpdateAssociationRequest

UpdateAssociationResult

UpdateAssociationStatusRequest

UpdateAssociationStatusResult

UpdateDocumentDefaultVersionRequest

UpdateDocumentDefaultVersionResult

UpdateDocumentRequest

UpdateDocumentResult

UpdateMaintenanceWindowRequest

UpdateMaintenanceWindowResult

UpdateMaintenanceWindowTargetRequest

UpdateMaintenanceWindowTargetResult

UpdateMaintenanceWindowTaskRequest

UpdateMaintenanceWindowTaskResult

UpdateManagedInstanceRoleRequest

UpdateManagedInstanceRoleResult

  • UpdateManagedInstanceRoleResult object

UpdatePatchBaselineRequest

UpdatePatchBaselineResult

Url

  • Url string

Version

  • Version string

Dependencies (2)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @datafire/amazonaws_ssm

    Repository

    github.com/DataFire/integrations

    Homepage

    github.com/DataFire/integrations#readme

    Weekly Downloads

    11

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    783 kB

    Total Files

    4

    Last publish

    Collaborators

    • datafire
    Try on RunKit
    Report malware