Package-level declarations
Types
Information includes the Amazon Web Services account ID where the current document is shared and the version shared with that account.
An activation registers one or more on-premises servers or virtual machines (VMs) with Amazon Web Services so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with Amazon Web Services Systems Manager is called a managed node.
The details for the CloudWatch alarm you want to apply to an automation or command.
The details about the state of your CloudWatch alarm.
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.
You must disassociate a document from all managed nodes before you can delete it.
Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
The specified association already exists.
Describes the parameters for a document.
The specified association doesn't exist.
Includes information about the specified association.
The specified execution ID doesn't exist. Verify the ID number and try again.
Filters used in the request.
Includes information about the specified association execution.
Filters for the association execution.
Describes a filter.
You can have at most 2,000 active associations.
Information about the association.
Describes an association status.
Information about the association version.
You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.
A structure that includes attributes that describe a document attachment.
An attribute of an attachment, such as the attachment name.
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.
Indicates that the Change Manager change template used in the change request was rejected or is still in a pending state.
An Automation runbook with the specified name couldn't be found.
An Automation runbook with the specified name and version couldn't be found.
Detailed information about the current state of an individual Automation execution.
A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.
The number of simultaneously running Automation executions exceeded the allowable limit.
Details about a specific Automation execution.
There is no automation execution information for the requested automation execution ID.
The specified step name and execution ID don't exist. Verify the information and try again.
Defines the basic information about a patch baseline override.
Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.
Configuration options for sending command output to Amazon CloudWatch Logs.
Describes a command filter.
An invocation is a copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. A command invocation returns status and detail information about a command you ran.
Describes plugin details.
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'.
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.
Information about a compliance item.
One or more filters. Use a filter to return a more specific list of results.
A summary of compliance information by compliance type.
You specified too many custom compliance types. You can specify a maximum of 10 different types.
A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.
Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.
Filter for the DescribeActivation API.
The specified document already exists.
A default version of a document.
Describes an Amazon Web Services Systems Manager document (SSM document).
This data type is deprecated. Instead, use DocumentKeyValuesFilter.
Describes the name of a SSM document.
One or more filters. Use a filter to return a more specific list of documents.
You can have at most 500 active SSM documents.
Details about the response to a document review request.
Parameters specified in a Systems Manager document that run on the server when the command is run.
The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.
An SSM document required by the current document.
Information about comments added to a document review request.
Information about a reviewer's response to a document review request.
Information about a document approval review.
The status of a document.
Version information about the document.
The document has too many versions. Delete one or more document versions and try again.
Error returned when the ID specified for a resource, such as a maintenance window or patch baseline, doesn't exist.
The content of the association document matches another document. Change the content of the document and try again.
The version name has already been used in this document. Specify a different version name, and then try again.
You can't specify a managed node ID in more than one association.
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.
Describes a failed association.
Information about an Automation failure.
You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service isn't available.
A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, OpsItemGroup is the only resource that supports Systems Manager resource policies. The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
The request body of the GetServiceSetting API operation.
The query result body of the GetServiceSetting API operation.
A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the Amazon Web Services Systems Manager User Guide.
Parameter Store doesn't 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.
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.
There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.
Status information about the aggregated associations.
One or more association documents on the managed node.
An S3 bucket where you want to store the results of this request.
The URL of S3 bucket where you want to store the results of this request.
Status information about the association.
Describes a filter for a specific list of managed nodes.
Describes a filter for a specific list of managed nodes. You can filter node information by using tags. You specify tags by using a key-value mapping.
The filters to describe or get information about your managed nodes.
Defines the high-level patch compliance state for a managed node, 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 managed node.
Defines a filter used in DescribeInstancePatchStatesForPatchGroup to scope down the information returned by the API.
An error occurred on the server side.
The activation isn't valid. The activation might have been deleted, or the ActivationId and the ActivationCode don't match.
The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try again.
The specified aggregator isn't valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.
The request doesn't meet the regular expression requirement.
The association isn't valid or doesn't exist.
The version you specified isn't 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.
The supplied parameters for invoking the specified Automation runbook are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.
The signal isn't valid for the current Automation execution.
The specified update status operation isn't valid.
The specified command ID isn't valid. Verify the ID and try again.
One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and try again.
The ID specified for the delete operation doesn't exist or isn't valid. Verify the ID and try again.
The specified SSM document doesn't exist.
The content for the document isn't valid.
You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.
The version of the document schema isn't supported.
The SSM document type isn't valid. Valid document types are described in the DocumentType property.
The document version isn't valid or doesn't exist.
The filter name isn't valid. Verify the you entered the correct name and try again.
The specified key isn't valid.
The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.
The filter value isn't valid. Verify the value and try again.
The following problems can cause this exception:
The specified filter value isn't valid.
The specified inventory group isn't valid.
You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.
The request isn't valid.
One or more content items isn't valid.
The query key ID isn't valid.
The specified token isn't valid.
One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon Simple Notification Service topic.
The delete inventory option specified isn't valid. Verify the option and try again.
The S3 bucket doesn't exist.
The output location isn't valid or doesn't exist.
You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
The permission type isn't supported. Share is the only supported permission type.
The plugin name isn't valid.
A policy attribute or its value is invalid.
The policy type isn't supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.
The resource ID isn't valid. Verify that you entered the correct ID and try again.
The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.
The specified inventory item result attribute isn't valid.
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 Amazon Web Services Systems Manager User Guide.
The schedule is invalid. Verify your cron or rate expression and try again.
The specified tag key or value isn't valid.
The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
TargetMap parameter isn't valid.
The parameter type name isn't valid.
The update isn't valid.
Specifies the inventory type and attribute for the aggregation execution.
Status information returned by the DeleteInventory operation.
Information about the delete operation.
Either a count, remaining count, or a version number in a delete inventory summary.
One or more filters. Use a filter to return a more specific list of results.
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.
Information collected from managed nodes based on your inventory policy document
Attributes are the entries within the inventory item content. It contains name and value.
The inventory item schema definition. Users can use this to compose inventory query filters.
Inventory query results.
The inventory result item.
The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again.
The inventory item has invalid content.
The inventory item size has exceeded the size limit.
Information about an Amazon Simple Storage Service (Amazon S3) bucket to write managed node-level logs to.
The parameters for an AUTOMATION task type.
Describes the information about an execution of a maintenance window.
Information about a task execution performed as part of a maintenance window execution.
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.
Filter used in the request. Supported filter keys depend on the API operation that includes the filter. API operations that use MaintenanceWindowFilter> include the following:
Information about the maintenance window.
The maintenance window to which the specified target belongs.
The parameters for a LAMBDA task type.
The parameters for a RUN_COMMAND task type.
The parameters for a STEP_FUNCTIONS task.
The target registered with the maintenance window.
Information about a task defined for a maintenance window.
The parameters for task execution.
Defines the values for a task parameter.
The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.
The size limit of a document is 64 KB.
Metadata to assign to an Application Manager application.
A summary of resources that aren't compliant. The summary is organized according to resource type.
Configurations for sending notifications.
One or more aggregators for viewing counts of OpsData using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.
The OpsData summary.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their Amazon Web Services resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can configure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any Amazon Web Services service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with Amazon Web Services resources from a single console.
You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
The OpsItem already exists.
The specified OpsItem is in the process of being deleted.
An object that defines the value of the key and its type in the OperationalData map.
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.
Summary information about an OpsItem event or that associated an OpsItem with a related item.
Describes an OpsItem filter.
Information about the user or resource that created an OpsItem event.
A specified parameter argument isn't valid. Verify the available arguments and try again.
The request caused OpsItems to exceed one or more quotas.
The specified OpsItem ID doesn't exist. Verify the ID and try again.
A notification about the OpsItem.
The Amazon Resource Name (ARN) is already associated with the OpsItem.
The association wasn't found using the parameters you specified in the call. Verify the information and try again.
Describes a filter for a specific list of related-item resources.
Summary information about related-item resources for an OpsItem.
A count of OpsItems.
Operational metadata for an application in Application Manager.
An OpsMetadata object already exists for the selected resource.
A filter to limit the number of OpsMetadata objects displayed.
One of the arguments passed is invalid.
The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.
Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.
The OpsMetadata object doesn't exist.
The system is processing too many concurrent updates. Wait a few moments and try again.
The OpsItem data type to return.
Information about the source where the association execution details are stored.
The parameter already exists. You can't create duplicate parameters.
Information about parameter usage.
One or more policies assigned to a parameter.
You have exceeded the number of parameters for this Amazon Web Services account. Delete one or more parameters and try again.
Parameter Store retains the 100 most recently created versions of a parameter. After this number of versions has been created, Parameter Store deletes the oldest version when a new one is created. However, if the oldest version has a label attached to it, Parameter Store won't delete the version and instead presents this error message:
Metadata includes information like the Amazon Resource Name (ARN) of the last user to update the parameter and the date and time the parameter was last used.
The parameter couldn't be found. Verify the name and try again.
The parameter name isn't valid.
This data type is deprecated. Instead, use ParameterStringFilter.
One or more filters. Use a filter to return a more specific list of results.
A parameter version can have a maximum of ten labels.
The specified parameter version wasn't found. Verify the parameter name and version, and try again.
A detailed status of the parent step.
Defines the basic information about a patch baseline.
Information about the state of a patch on a particular managed node as it relates to the patch baseline used to patch the node.
Defines which patches should be included in a patch baseline.
A set of patch filters, typically used for approval rules.
The mapping between a patch group and the patch baseline the patch group is registered with.
Defines a filter used in Patch Manager APIs. Supported filter keys depend on the API operation that includes the filter. Patch Manager API operations that use PatchOrchestratorFilter include the following:
A set of rules defining the approval rules for a patch baseline.
Information about the patches to use to update the managed nodes, including target operating systems and source repository. Applies to Linux managed nodes only.
Information about the approval status of a patch.
You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.
An aggregate of step execution statuses displayed in the Amazon Web Services Systems Manager console for a multi-Region and multi-account Automation execution.
Reserved for internal use.
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.
The request body of the ResetServiceSetting API operation.
The result body of the ResetServiceSetting API operation.
Information about targets that resolved during the Automation execution.
Compliance summary information for a specific resource.
A sync configuration with the same name already exists.
Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from Organizations or, if an Amazon Web Services organization isn't present, from multiple Amazon Web Services Regions.
Another UpdateResourceDataSync request is being processed. Wait a few minutes and try again.
You have exceeded the allowed maximum sync configurations.
Synchronize Amazon Web Services Systems Manager Inventory data from multiple Amazon Web Services accounts defined in Organizations to a centralized Amazon S3 bucket. Data is synchronized to individual key prefixes in the central bucket. Each key prefix represents a different Amazon Web Services account ID.
The specified sync configuration is invalid.
Information about a resource data sync configuration, including its current status and last successful sync.
The specified sync name wasn't found.
The Organizations organizational unit data source for the sync.
Information about the target S3 bucket for the resource data sync.
Information about the source of the data included in the resource data sync.
The data type name for including resource data sync state. There are four sync states:
Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.
Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.
The specified parameter to be shared could not be found.
The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.
One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. Verify these limits and try again.
No policies with the specified policy ID and hash could be found.
The inventory item result attribute.
Information about the result of a document review request.
An S3 bucket where you want to store the results of this request.
A URL for the Amazon Web Services Systems Manager (Systems Manager) bucket where you want to store the results of this request.
Information about a scheduled execution for a maintenance window.
The service setting data structure.
The specified service setting wasn't found. Either the service name or the setting hasn't been provisioned by the Amazon Web Services service team.
Describes a filter for Session Manager information.
Reserved for future use.
The number of managed nodes found for each patch severity level defined in the request filter.
Base class for all service related exceptions thrown by the Ssm client
The updated status is the same as the current status.
Detailed information about an the execution state of an Automation step.
A filter to limit the amount of step execution information returned by the call.
The sub-type count exceeded the limit for the inventory type.
Metadata that you assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Amazon Web Services Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata.
You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.
The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.
The specified target managed node for the session isn't fully configured for use with Session Manager. For more information, see Getting started with Session Manager in the Amazon Web Services Systems Manager User Guide. This error is also returned if you attempt to start a session on a managed node that is located in a different account or Region
The Targets parameter includes too many tags. Remove one or more tags and try the command again.
There are concurrent updates for a resource that supports one update at a time.
The size of inventory data has exceeded the total size limit for the resource.
The calendar entry contained in the specified SSM document isn't supported.
Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Enabling the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.
The Context attribute that you specified for the InventoryItem isn't allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.
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.
The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
The parameter type isn't supported.
The document doesn't support the platform type of the given managed node ID(s). For example, you sent an document for a Windows managed node to a Linux node.
The request body of the UpdateServiceSetting API operation.
The result body of the UpdateServiceSetting API operation.