ssm-2014-11-06
library
Classes
AccountSharingInfo
Information includes the AWS account ID where the current document is shared
and the version shared with that account.
Activation
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.
AddTagsToResourceResult
Association
Describes an association of a Systems Manager document and an instance.
AssociationDescription
Describes the parameters for a document.
AssociationExecution
Includes information about the specified association.
AssociationExecutionFilter
Filters used in the request.
AssociationExecutionTarget
Includes information about the specified association execution.
AssociationExecutionTargetsFilter
Filters for the association execution.
AssociationFilter
Describes a filter.
AssociationOverview
Information about the association.
AssociationStatus
Describes an association status.
AssociationVersionInfo
Information about the association version.
AttachmentContent
A structure that includes attributes that describe a document attachment.
AttachmentInformation
An attribute of an attachment, such as the attachment name.
AttachmentsSource
Identifying information about a document attachment, including the file name
and a key-value pair that identifies the location of an attachment to a
document.
AutomationExecution
Detailed information about the current state of an individual Automation
execution.
AutomationExecutionFilter
A filter used to match specific automation executions. This is used to limit
the scope of Automation execution information returned.
AutomationExecutionMetadata
Details about a specific Automation execution.
AwsClientCredentials
AWS credentials.
CancelCommandResult
Whether or not the command was successfully canceled. There is no guarantee
that a request can be canceled.
CancelMaintenanceWindowExecutionResult
CloudWatchOutputConfig
Configuration options for sending command output to CloudWatch Logs.
Command
Describes a command request.
CommandFilter
Describes a command filter.
CommandInvocation
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 runs 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
ran.
CommandPlugin
Describes plugin details.
ComplianceExecutionSummary
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'.
ComplianceItem
Information about the compliance as defined by the resource type. For
example, for a patch resource type, Items includes information
about the PatchSeverity, Classification, and so on.
ComplianceItemEntry
Information about a compliance item.
ComplianceStringFilter
One or more filters. Use a filter to return a more specific list of results.
ComplianceSummaryItem
A summary of compliance information by compliance type.
CompliantSummary
A summary of resources that are compliant. The summary is organized
according to the resource count for each compliance type.
CreateActivationResult
CreateAssociationBatchRequestEntry
Describes the association of a Systems Manager SSM document and an instance.
CreateAssociationBatchResult
CreateAssociationResult
CreateDocumentResult
CreateMaintenanceWindowResult
CreateOpsItemResponse
CreateOpsMetadataResult
CreatePatchBaselineResult
CreateResourceDataSyncResult
DeleteActivationResult
DeleteAssociationResult
DeleteDocumentResult
DeleteInventoryResult
DeleteMaintenanceWindowResult
DeleteOpsMetadataResult
DeleteParameterResult
DeleteParametersResult
DeletePatchBaselineResult
DeleteResourceDataSyncResult
DeregisterManagedInstanceResult
DeregisterPatchBaselineForPatchGroupResult
DeregisterTargetFromMaintenanceWindowResult
DeregisterTaskFromMaintenanceWindowResult
DescribeActivationsFilter
Filter for the DescribeActivation API.
DescribeActivationsResult
DescribeAssociationExecutionsResult
DescribeAssociationExecutionTargetsResult
DescribeAssociationResult
DescribeAutomationExecutionsResult
DescribeAutomationStepExecutionsResult
DescribeAvailablePatchesResult
DescribeDocumentPermissionResponse
DescribeDocumentResult
DescribeEffectiveInstanceAssociationsResult
DescribeEffectivePatchesForPatchBaselineResult
DescribeInstanceAssociationsStatusResult
DescribeInstanceInformationResult
DescribeInstancePatchesResult
DescribeInstancePatchStatesForPatchGroupResult
DescribeInstancePatchStatesResult
DescribeInventoryDeletionsResult
DescribeMaintenanceWindowExecutionsResult
DescribeMaintenanceWindowExecutionTaskInvocationsResult
DescribeMaintenanceWindowExecutionTasksResult
DescribeMaintenanceWindowScheduleResult
DescribeMaintenanceWindowsForTargetResult
DescribeMaintenanceWindowsResult
DescribeMaintenanceWindowTargetsResult
DescribeMaintenanceWindowTasksResult
DescribeOpsItemsResponse
DescribeParametersResult
DescribePatchBaselinesResult
DescribePatchGroupsResult
DescribePatchGroupStateResult
DescribePatchPropertiesResult
DescribeSessionsResponse
DocumentDefaultVersionDescription
A default version of a document.
DocumentDescription
Describes a Systems Manager document.
DocumentFilter
This data type is deprecated. Instead, use DocumentKeyValuesFilter .
DocumentIdentifier
Describes the name of a Systems Manager document.
DocumentKeyValuesFilter
One or more filters. Use a filter to return a more specific list of
documents.
DocumentMetadataResponseInfo
Details about the response to a document review request.
DocumentParameter
Parameters specified in a System Manager document that run on the server
when the command is run.
DocumentRequires
An SSM document required by the current document.
Information about comments added to a document review request.
DocumentReviewerResponseSource
Information about a reviewer's response to a document review request.
DocumentReviews
Information about a document approval review.
DocumentVersionInfo
Version information about the document.
EffectivePatch
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.
FailedCreateAssociation
Describes a failed association.
FailureDetails
Information about an Automation failure.
GetAutomationExecutionResult
GetCalendarStateResponse
GetCommandInvocationResult
GetConnectionStatusResponse
GetDefaultPatchBaselineResult
GetDeployablePatchSnapshotForInstanceResult
GetDocumentResult
GetInventoryResult
GetInventorySchemaResult
GetMaintenanceWindowExecutionResult
GetMaintenanceWindowExecutionTaskInvocationResult
GetMaintenanceWindowExecutionTaskResult
GetMaintenanceWindowResult
GetMaintenanceWindowTaskResult
GetOpsItemResponse
GetOpsMetadataResult
GetOpsSummaryResult
GetParameterHistoryResult
GetParameterResult
GetParametersByPathResult
GetParametersResult
GetPatchBaselineForPatchGroupResult
GetPatchBaselineResult
GetServiceSettingResult
The query result body of the GetServiceSetting API action.
InstanceAggregatedAssociationOverview
Status information about the aggregated associations.
InstanceAssociation
One or more association documents on the instance.
InstanceAssociationOutputLocation
An S3 bucket where you want to store the results of this request.
InstanceAssociationOutputUrl
The URL of S3 bucket where you want to store the results of this request.
InstanceAssociationStatusInfo
Status information about the instance association.
InstanceInformation
Describes a filter for a specific list of instances.
InstanceInformationFilter
Describes a filter for a specific list of instances. You can filter
instances information by using tags. You specify tags by using a key-value
mapping.
InstanceInformationStringFilter
The filters to describe or get information about your managed instances.
InstancePatchState
Defines the high-level patch compliance state for a managed instance,
providing information about the number of installed, missing, not
applicable, and failed patches along with metadata about the operation when
this information was gathered for the instance.
InstancePatchStateFilter
Defines a filter used in DescribeInstancePatchStatesForPatchGroup
used to scope down the information returned by the API.
InventoryAggregator
Specifies the inventory type and attribute for the aggregation execution.
InventoryDeletionStatusItem
Status information returned by the DeleteInventory action.
InventoryDeletionSummary
Information about the delete operation.
InventoryDeletionSummaryItem
Either a count, remaining count, or a version number in a delete inventory
summary.
InventoryFilter
One or more filters. Use a filter to return a more specific list of results.
InventoryGroup
A user-defined set of one or more filters on which to aggregate inventory
data. Groups return a count of resources that match and don't match the
specified criteria.
InventoryItem
Information collected from managed instances based on your inventory policy
document
InventoryItemAttribute
Attributes are the entries within the inventory item content. It contains
name and value.
InventoryItemSchema
The inventory item schema definition. Users can use this to compose
inventory query filters.
InventoryResultEntity
Inventory query results.
InventoryResultItem
The inventory result item.
LabelParameterVersionResult
ListAssociationsResult
ListAssociationVersionsResult
ListCommandInvocationsResult
ListCommandsResult
ListComplianceItemsResult
ListComplianceSummariesResult
ListDocumentMetadataHistoryResponse
ListDocumentsResult
ListDocumentVersionsResult
ListInventoryEntriesResult
ListOpsItemEventsResponse
ListOpsMetadataResult
ListResourceComplianceSummariesResult
ListResourceDataSyncResult
ListTagsForResourceResult
LoggingInfo
Information about an S3 bucket to write instance-level logs to.
MaintenanceWindowAutomationParameters
The parameters for an AUTOMATION task type.
MaintenanceWindowExecution
Describes the information about an execution of a maintenance window.
MaintenanceWindowExecutionTaskIdentity
Information about a task execution performed as part of a maintenance window
execution.
MaintenanceWindowExecutionTaskInvocationIdentity
Describes the information about a task invocation for a particular target as
part of a task execution performed as part of a maintenance window
execution.
MaintenanceWindowFilter
Filter used in the request. Supported filter keys are Name and Enabled.
MaintenanceWindowIdentity
Information about the maintenance window.
MaintenanceWindowIdentityForTarget
The maintenance window to which the specified target belongs.
MaintenanceWindowLambdaParameters
The parameters for a LAMBDA task type.
MaintenanceWindowRunCommandParameters
The parameters for a RUN_COMMAND task type.
MaintenanceWindowStepFunctionsParameters
The parameters for a STEP_FUNCTIONS task.
MaintenanceWindowTarget
The target registered with the maintenance window.
MaintenanceWindowTask
Information about a task defined for a maintenance window.
MaintenanceWindowTaskInvocationParameters
The parameters for task execution.
MaintenanceWindowTaskParameterValueExpression
Defines the values for a task parameter.
MetadataValue
Metadata to assign to an Application Manager application.
ModifyDocumentPermissionResponse
NonCompliantSummary
A summary of resources that are not compliant. The summary is organized
according to resource type.
NotificationConfig
Configurations for sending notifications.
OpsAggregator
One or more aggregators for viewing counts of OpsItems using different
dimensions such as Source, CreatedTime, or
Source and CreatedTime, to name a few.
OpsEntity
The result of the query.
OpsEntityItem
The OpsItem summaries result item.
OpsFilter
A filter for viewing OpsItem summaries.
OpsItem
Operations engineers and IT professionals use OpsCenter to view,
investigate, and remediate operational issues impacting the performance and
health of their AWS resources. For more information, see AWS
Systems Manager OpsCenter in the AWS Systems Manager User Guide .
OpsItemDataValue
An object that defines the value of the key and its type in the
OperationalData map.
OpsItemEventFilter
Describes a filter for a specific list of OpsItem events. You can filter
event information by using tags. You specify tags by using a key-value pair
mapping.
OpsItemEventSummary
Summary information about an OpsItem event.
OpsItemFilter
Describes an OpsItem filter.
OpsItemIdentity
Information about the user or resource that created an OpsItem event.
OpsItemNotification
A notification about the OpsItem.
OpsItemSummary
A count of OpsItems.
OpsMetadata
Operational metadata for an application in Application Manager.
OpsMetadataFilter
A filter to limit the number of OpsMetadata objects displayed.
OpsResultAttribute
The OpsItem data type to return.
OutputSource
Information about the source where the association execution details are
stored.
Parameter
An Systems Manager parameter in Parameter Store.
ParameterHistory
Information about parameter usage.
ParameterInlinePolicy
One or more policies assigned to a parameter.
ParameterMetadata
Metadata includes information like the ARN of the last user and the
date/time the parameter was last used.
ParametersFilter
This data type is deprecated. Instead, use ParameterStringFilter .
ParameterStringFilter
One or more filters. Use a filter to return a more specific list of results.
Patch
Represents metadata about a patch.
PatchBaselineIdentity
Defines the basic information about a patch baseline.
PatchComplianceData
Information about the state of a patch on a particular instance as it
relates to the patch baseline used to patch the instance.
PatchFilter
Defines which patches should be included in a patch baseline.
PatchFilterGroup
A set of patch filters, typically used for approval rules.
PatchGroupPatchBaselineMapping
The mapping between a patch group and the patch baseline the patch group is
registered with.
PatchOrchestratorFilter
Defines a filter used in Patch Manager APIs.
PatchRule
Defines an approval rule for a patch baseline.
PatchRuleGroup
A set of rules defining the approval rules for a patch baseline.
PatchSource
Information about the patches to use to update the instances, including
target operating systems and source repository. Applies to Linux instances
only.
PatchStatus
Information about the approval status of a patch.
ProgressCounters
An aggregate of step execution statuses displayed in the AWS Console for a
multi-Region and multi-account Automation execution.
PutComplianceItemsResult
PutInventoryResult
PutParameterResult
RegisterDefaultPatchBaselineResult
RegisterPatchBaselineForPatchGroupResult
RegisterTargetWithMaintenanceWindowResult
RegisterTaskWithMaintenanceWindowResult
RelatedOpsItem
An OpsItems that shares something in common with the current OpsItem. For
example, related OpsItems can include OpsItems with similar error messages,
impacted resources, or statuses for the impacted resource.
RemoveTagsFromResourceResult
ResetServiceSettingResult
The result body of the ResetServiceSetting API action.
ResolvedTargets
Information about targets that resolved during the Automation execution.
ResourceComplianceSummaryItem
Compliance summary information for a specific resource.
ResourceDataSyncAwsOrganizationsSource
Information about the AwsOrganizationsSource resource data sync source. A
sync source of this type can synchronize data from AWS Organizations or, if
an AWS Organization is not present, from multiple AWS Regions.
ResourceDataSyncDestinationDataSharing
Synchronize Systems Manager Inventory data from multiple AWS accounts
defined in AWS Organizations to a centralized S3 bucket. Data is
synchronized to individual key prefixes in the central bucket. Each key
prefix represents a different AWS account ID.
ResourceDataSyncItem
Information about a Resource Data Sync configuration, including its current
status and last successful sync.
ResourceDataSyncOrganizationalUnit
The AWS Organizations organizational unit data source for the sync.
ResourceDataSyncS3Destination
Information about the target S3 bucket for the Resource Data Sync.
ResourceDataSyncSource
Information about the source of the data included in the resource data sync.
ResourceDataSyncSourceWithState
The data type name for including resource data sync state. There are four
sync states:
ResultAttribute
The inventory item result attribute.
ResumeSessionResponse
ReviewInformation
Information about the result of a document review request.
Runbook
Information about an Automation runbook (Automation document) used in a
runbook workflow in Change Manager.
S3OutputLocation
An S3 bucket where you want to store the results of this request.
S3OutputUrl
A URL for the S3 bucket where you want to store the results of this request.
ScheduledWindowExecution
Information about a scheduled execution for a maintenance window.
SendAutomationSignalResult
SendCommandResult
ServiceSetting
The service setting data structure.
Session
Information about a Session Manager connection to an instance.
SessionFilter
Describes a filter for Session Manager information.
SessionManagerOutputUrl
Reserved for future use.
SeveritySummary
The number of managed instances found for each patch severity level defined
in the request filter.
SSM
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 Elastic
Compute Cloud instance (EC2 instance), or any on-premises server or virtual
machine (VM) in your hybrid environment that has been configured for Systems
Manager.
StartAssociationsOnceResult
StartAutomationExecutionResult
StartChangeRequestExecutionResult
StartSessionResponse
StepExecution
Detailed information about an the execution state of an Automation step.
StepExecutionFilter
A filter to limit the amount of step execution information returned by the
call.
StopAutomationExecutionResult
Tag
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.
Target
An array of search criteria that targets instances using a Key,Value
combination that you specify.
Supported formats include the following.
TargetLocation
The combination of AWS Regions and accounts targeted by the current
Automation execution.
TerminateSessionResponse
UpdateAssociationResult
UpdateAssociationStatusResult
UpdateDocumentDefaultVersionResult
UpdateDocumentMetadataResponse
UpdateDocumentResult
UpdateMaintenanceWindowResult
UpdateMaintenanceWindowTargetResult
UpdateMaintenanceWindowTaskResult
UpdateManagedInstanceRoleResult
UpdateOpsItemResponse
UpdateOpsMetadataResult
UpdatePatchBaselineResult
UpdateResourceDataSyncResult
UpdateServiceSettingResult
The result body of the UpdateServiceSetting API action.
