AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class 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.

Class AddTagsToResourceRequest

Container for the parameters to the AddTagsToResource operation. Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, Maintenance Windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.

Each resource can have a maximum of 10 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

Class AddTagsToResourceResponse

This is the response object from the AddTagsToResource operation.

Class AlreadyExistsException

SimpleSystemsManagement exception

Class AssociatedInstancesException

SimpleSystemsManagement exception

Class Association

Describes an association of a Systems Manager document and an instance.

Class AssociationAlreadyExistsException

SimpleSystemsManagement exception

Class AssociationDescription

Describes the parameters for a document.

Class AssociationDoesNotExistException

SimpleSystemsManagement exception

Class AssociationFilter

Describes a filter.

Class AssociationLimitExceededException

SimpleSystemsManagement exception

Class AssociationOverview

Information about the association.

Class AssociationStatus

Describes an association status.

Class AssociationVersionInfo

Information about the association version.

Class AssociationVersionLimitExceededException

SimpleSystemsManagement exception

Class AutomationDefinitionNotFoundException

SimpleSystemsManagement exception

Class AutomationDefinitionVersionNotFoundException

SimpleSystemsManagement exception

Class AutomationExecution

Detailed information about the current state of an individual Automation execution.

Class AutomationExecutionFilter

A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.

Class AutomationExecutionLimitExceededException

SimpleSystemsManagement exception

Class AutomationExecutionMetadata

Details about a specific Automation execution.

Class AutomationExecutionNotFoundException

SimpleSystemsManagement exception

Class CancelCommandRequest

Container for the parameters to the CancelCommand operation. Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

Class CancelCommandResponse

Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.

Class Command

Describes a command request.

Class CommandFilter

Describes a command filter.

Class 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 executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.

Class CommandPlugin

Describes plugin details.

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

Class 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, etc.

Class ComplianceItemEntry

Information about a compliance item.

Class ComplianceStringFilter

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

Class ComplianceSummaryItem

A summary of compliance information by compliance type.

Class ComplianceTypeCountLimitExceededException

SimpleSystemsManagement exception

Class CompliantSummary

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

Class CreateActivationRequest

Container for the parameters to the CreateActivation operation. Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments.

Class CreateActivationResponse

This is the response object from the CreateActivation operation.

Class CreateAssociationBatchRequest

Container for the parameters to the CreateAssociationBatch operation. Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

Class CreateAssociationBatchRequestEntry

Describes the association of a Systems Manager document and an instance.

Class CreateAssociationBatchResponse

This is the response object from the CreateAssociationBatch operation.

Class CreateAssociationRequest

Container for the parameters to the CreateAssociation operation. Associates the specified Systems Manager document with the specified instances or targets.

When you associate a document with one or more instances using instance IDs or tags, the SSM Agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

Class CreateAssociationResponse

This is the response object from the CreateAssociation operation.

Class CreateDocumentRequest

Container for the parameters to the CreateDocument operation. Creates a Systems Manager document.

After you create a document, you can use CreateAssociation to associate it with one or more running instances.

Class CreateDocumentResponse

This is the response object from the CreateDocument operation.

Class CreateMaintenanceWindowRequest

Container for the parameters to the CreateMaintenanceWindow operation. Creates a new Maintenance Window.

Class CreateMaintenanceWindowResponse

This is the response object from the CreateMaintenanceWindow operation.

Class CreatePatchBaselineRequest

Container for the parameters to the CreatePatchBaseline operation. Creates a patch baseline.

Class CreatePatchBaselineResponse

This is the response object from the CreatePatchBaseline operation.

Class CreateResourceDataSyncRequest

Container for the parameters to the CreateResourceDataSync operation. Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync operation.

By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.

Class CreateResourceDataSyncResponse

This is the response object from the CreateResourceDataSync operation.

Class CustomSchemaCountLimitExceededException

SimpleSystemsManagement exception

Class DeleteActivationRequest

Container for the parameters to the DeleteActivation operation. Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

Class DeleteActivationResponse

This is the response object from the DeleteActivation operation.

Class DeleteAssociationRequest

Container for the parameters to the DeleteAssociation operation. Disassociates the specified Systems Manager document from the specified instance.

When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

Class DeleteAssociationResponse

This is the response object from the DeleteAssociation operation.

Class DeleteDocumentRequest

Container for the parameters to the DeleteDocument operation. Deletes the Systems Manager document and all instance associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

Class DeleteDocumentResponse

This is the response object from the DeleteDocument operation.

Class DeleteMaintenanceWindowRequest

Container for the parameters to the DeleteMaintenanceWindow operation. Deletes a Maintenance Window.

Class DeleteMaintenanceWindowResponse

This is the response object from the DeleteMaintenanceWindow operation.

Class DeleteParameterRequest

Container for the parameters to the DeleteParameter operation. Delete a parameter from the system.

Class DeleteParameterResponse

This is the response object from the DeleteParameter operation.

Class DeleteParametersRequest

Container for the parameters to the DeleteParameters operation. Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2 console.

Class DeleteParametersResponse

This is the response object from the DeleteParameters operation.

Class DeletePatchBaselineRequest

Container for the parameters to the DeletePatchBaseline operation. Deletes a patch baseline.

Class DeletePatchBaselineResponse

This is the response object from the DeletePatchBaseline operation.

Class DeleteResourceDataSyncRequest

Container for the parameters to the DeleteResourceDataSync operation. Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.

Class DeleteResourceDataSyncResponse

This is the response object from the DeleteResourceDataSync operation.

Class DeregisterManagedInstanceRequest

Container for the parameters to the DeregisterManagedInstance operation. Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling the SSM Agent first.

Class DeregisterManagedInstanceResponse

This is the response object from the DeregisterManagedInstance operation.

Class DeregisterPatchBaselineForPatchGroupRequest

Container for the parameters to the DeregisterPatchBaselineForPatchGroup operation. Removes a patch group from a patch baseline.

Class DeregisterPatchBaselineForPatchGroupResponse

This is the response object from the DeregisterPatchBaselineForPatchGroup operation.

Class DeregisterTargetFromMaintenanceWindowRequest

Container for the parameters to the DeregisterTargetFromMaintenanceWindow operation. Removes a target from a Maintenance Window.

Class DeregisterTargetFromMaintenanceWindowResponse

This is the response object from the DeregisterTargetFromMaintenanceWindow operation.

Class DeregisterTaskFromMaintenanceWindowRequest

Container for the parameters to the DeregisterTaskFromMaintenanceWindow operation. Removes a task from a Maintenance Window.

Class DeregisterTaskFromMaintenanceWindowResponse

This is the response object from the DeregisterTaskFromMaintenanceWindow operation.

Class DescribeActivationsFilter

Filter for the DescribeActivation API.

Class DescribeActivationsRequest

Container for the parameters to the DescribeActivations operation. Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.

Class DescribeActivationsResponse

This is the response object from the DescribeActivations operation.

Class DescribeAssociationRequest

Container for the parameters to the DescribeAssociation operation. Describes the associations for the specified Systems Manager document or instance.

Class DescribeAssociationResponse

This is the response object from the DescribeAssociation operation.

Class DescribeAutomationExecutionsRequest

Container for the parameters to the DescribeAutomationExecutions operation. Provides details about all active and terminated Automation executions.

Class DescribeAutomationExecutionsResponse

This is the response object from the DescribeAutomationExecutions operation.

Class DescribeAvailablePatchesRequest

Container for the parameters to the DescribeAvailablePatches operation. Lists all patches that could possibly be included in a patch baseline.

Class DescribeAvailablePatchesResponse

This is the response object from the DescribeAvailablePatches operation.

Class DescribeDocumentPermissionRequest

Container for the parameters to the DescribeDocumentPermission operation. Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).

Class DescribeDocumentPermissionResponse

This is the response object from the DescribeDocumentPermission operation.

Class DescribeDocumentRequest

Container for the parameters to the DescribeDocument operation. Describes the specified Systems Manager document.

Class DescribeDocumentResponse

This is the response object from the DescribeDocument operation.

Class DescribeEffectiveInstanceAssociationsRequest

Container for the parameters to the DescribeEffectiveInstanceAssociations operation. All associations for the instance(s).

Class DescribeEffectiveInstanceAssociationsResponse

This is the response object from the DescribeEffectiveInstanceAssociations operation.

Class DescribeEffectivePatchesForPatchBaselineRequest

Container for the parameters to the DescribeEffectivePatchesForPatchBaseline operation. Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.

Class DescribeEffectivePatchesForPatchBaselineResponse

This is the response object from the DescribeEffectivePatchesForPatchBaseline operation.

Class DescribeInstanceAssociationsStatusRequest

Container for the parameters to the DescribeInstanceAssociationsStatus operation. The status of the associations for the instance(s).

Class DescribeInstanceAssociationsStatusResponse

This is the response object from the DescribeInstanceAssociationsStatus operation.

Class DescribeInstanceInformationRequest

Container for the parameters to the DescribeInstanceInformation operation. Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

Class DescribeInstanceInformationResponse

This is the response object from the DescribeInstanceInformation operation.

Class DescribeInstancePatchesRequest

Container for the parameters to the DescribeInstancePatches operation. Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

Class DescribeInstancePatchesResponse

This is the response object from the DescribeInstancePatches operation.

Class DescribeInstancePatchStatesForPatchGroupRequest

Container for the parameters to the DescribeInstancePatchStatesForPatchGroup operation. Retrieves the high-level patch state for the instances in the specified patch group.

Class DescribeInstancePatchStatesForPatchGroupResponse

This is the response object from the DescribeInstancePatchStatesForPatchGroup operation.

Class DescribeInstancePatchStatesRequest

Container for the parameters to the DescribeInstancePatchStates operation. Retrieves the high-level patch state of one or more instances.

Class DescribeInstancePatchStatesResponse

This is the response object from the DescribeInstancePatchStates operation.

Class DescribeMaintenanceWindowExecutionsRequest

Container for the parameters to the DescribeMaintenanceWindowExecutions operation. Lists the executions of a Maintenance Window. This includes information about when the Maintenance Window was scheduled to be active, and information about tasks registered and run with the Maintenance Window.

Class DescribeMaintenanceWindowExecutionsResponse

This is the response object from the DescribeMaintenanceWindowExecutions operation.

Class DescribeMaintenanceWindowExecutionTaskInvocationsRequest

Container for the parameters to the DescribeMaintenanceWindowExecutionTaskInvocations operation. Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.

Class DescribeMaintenanceWindowExecutionTaskInvocationsResponse

This is the response object from the DescribeMaintenanceWindowExecutionTaskInvocations operation.

Class DescribeMaintenanceWindowExecutionTasksRequest

Container for the parameters to the DescribeMaintenanceWindowExecutionTasks operation. For a given Maintenance Window execution, lists the tasks that were executed.

Class DescribeMaintenanceWindowExecutionTasksResponse

This is the response object from the DescribeMaintenanceWindowExecutionTasks operation.

Class DescribeMaintenanceWindowsRequest

Container for the parameters to the DescribeMaintenanceWindows operation. Retrieves the Maintenance Windows in an AWS account.

Class DescribeMaintenanceWindowsResponse

This is the response object from the DescribeMaintenanceWindows operation.

Class DescribeMaintenanceWindowTargetsRequest

Container for the parameters to the DescribeMaintenanceWindowTargets operation. Lists the targets registered with the Maintenance Window.

Class DescribeMaintenanceWindowTargetsResponse

This is the response object from the DescribeMaintenanceWindowTargets operation.

Class DescribeMaintenanceWindowTasksRequest

Container for the parameters to the DescribeMaintenanceWindowTasks operation. Lists the tasks in a Maintenance Window.

Class DescribeMaintenanceWindowTasksResponse

This is the response object from the DescribeMaintenanceWindowTasks operation.

Class DescribeParametersRequest

Container for the parameters to the DescribeParameters operation. Get information about a parameter.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Class DescribeParametersResponse

This is the response object from the DescribeParameters operation.

Class DescribePatchBaselinesRequest

Container for the parameters to the DescribePatchBaselines operation. Lists the patch baselines in your AWS account.

Class DescribePatchBaselinesResponse

This is the response object from the DescribePatchBaselines operation.

Class DescribePatchGroupsRequest

Container for the parameters to the DescribePatchGroups operation. Lists all patch groups that have been registered with patch baselines.

Class DescribePatchGroupsResponse

This is the response object from the DescribePatchGroups operation.

Class DescribePatchGroupStateRequest

Container for the parameters to the DescribePatchGroupState operation. Returns high-level aggregated patch compliance state for a patch group.

Class DescribePatchGroupStateResponse

This is the response object from the DescribePatchGroupState operation.

Class DocumentAlreadyExistsException

SimpleSystemsManagement exception

Class DocumentDefaultVersionDescription

A default version of a document.

Class DocumentDescription

Describes a Systems Manager document.

Class DocumentFilter

Describes a filter.

Class DocumentIdentifier

Describes the name of a Systems Manager document.

Class DocumentKeyValuesFilter

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

Class DocumentLimitExceededException

SimpleSystemsManagement exception

Class DocumentParameter

Parameters specified in a System Manager document that execute on the server when the command is run.

Class DocumentPermissionLimitException

SimpleSystemsManagement exception

Class DocumentVersionInfo

Version information about the document.

Class DocumentVersionLimitExceededException

SimpleSystemsManagement exception

Class DoesNotExistException

SimpleSystemsManagement exception

Class DuplicateDocumentContentException

SimpleSystemsManagement exception

Class DuplicateInstanceIdException

SimpleSystemsManagement exception

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

Class FailedCreateAssociation

Describes a failed association.

Class FailureDetails

Information about an Automation failure.

Class FeatureNotAvailableException

SimpleSystemsManagement exception

Class GetAutomationExecutionRequest

Container for the parameters to the GetAutomationExecution operation. Get detailed information about a particular Automation execution.

Class GetAutomationExecutionResponse

This is the response object from the GetAutomationExecution operation.

Class GetCommandInvocationRequest

Container for the parameters to the GetCommandInvocation operation. Returns detailed information about command execution for an invocation or plugin.

Class GetCommandInvocationResponse

This is the response object from the GetCommandInvocation operation.

Class GetDefaultPatchBaselineRequest

Container for the parameters to the GetDefaultPatchBaseline operation. Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

Class GetDefaultPatchBaselineResponse

This is the response object from the GetDefaultPatchBaseline operation.

Class GetDeployablePatchSnapshotForInstanceRequest

Container for the parameters to the GetDeployablePatchSnapshotForInstance operation. Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.

Class GetDeployablePatchSnapshotForInstanceResponse

This is the response object from the GetDeployablePatchSnapshotForInstance operation.

Class GetDocumentRequest

Container for the parameters to the GetDocument operation. Gets the contents of the specified Systems Manager document.

Class GetDocumentResponse

This is the response object from the GetDocument operation.

Class GetInventoryRequest

Container for the parameters to the GetInventory operation. Query inventory information.

Class GetInventoryResponse

This is the response object from the GetInventory operation.

Class GetInventorySchemaRequest

Container for the parameters to the GetInventorySchema operation. Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

Class GetInventorySchemaResponse

This is the response object from the GetInventorySchema operation.

Class GetMaintenanceWindowExecutionRequest

Container for the parameters to the GetMaintenanceWindowExecution operation. Retrieves details about a specific task executed as part of a Maintenance Window execution.

Class GetMaintenanceWindowExecutionResponse

This is the response object from the GetMaintenanceWindowExecution operation.

Class GetMaintenanceWindowExecutionTaskInvocationRequest

Container for the parameters to the GetMaintenanceWindowExecutionTaskInvocation operation. Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.

Class GetMaintenanceWindowExecutionTaskInvocationResponse

This is the response object from the GetMaintenanceWindowExecutionTaskInvocation operation.

Class GetMaintenanceWindowExecutionTaskRequest

Container for the parameters to the GetMaintenanceWindowExecutionTask operation. Retrieves the details about a specific task executed as part of a Maintenance Window execution.

Class GetMaintenanceWindowExecutionTaskResponse

This is the response object from the GetMaintenanceWindowExecutionTask operation.

Class GetMaintenanceWindowRequest

Container for the parameters to the GetMaintenanceWindow operation. Retrieves a Maintenance Window.

Class GetMaintenanceWindowResponse

This is the response object from the GetMaintenanceWindow operation.

Class GetMaintenanceWindowTaskRequest

Container for the parameters to the GetMaintenanceWindowTask operation. Lists the tasks in a Maintenance Window.

Class GetMaintenanceWindowTaskResponse

This is the response object from the GetMaintenanceWindowTask operation.

Class GetParameterHistoryRequest

Container for the parameters to the GetParameterHistory operation. Query a list of all parameters used by the AWS account.

Class GetParameterHistoryResponse

This is the response object from the GetParameterHistory operation.

Class GetParameterRequest

Container for the parameters to the GetParameter operation. Get information about a parameter by using the parameter name.

Class GetParameterResponse

This is the response object from the GetParameter operation.

Class GetParametersByPathRequest

Container for the parameters to the GetParametersByPath operation. Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters.

Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

Class GetParametersByPathResponse

This is the response object from the GetParametersByPath operation.

Class GetParametersRequest

Container for the parameters to the GetParameters operation. Get details of a parameter.

Class GetParametersResponse

This is the response object from the GetParameters operation.

Class GetPatchBaselineForPatchGroupRequest

Container for the parameters to the GetPatchBaselineForPatchGroup operation. Retrieves the patch baseline that should be used for the specified patch group.

Class GetPatchBaselineForPatchGroupResponse

This is the response object from the GetPatchBaselineForPatchGroup operation.

Class GetPatchBaselineRequest

Container for the parameters to the GetPatchBaseline operation. Retrieves information about a patch baseline.

Class GetPatchBaselineResponse

This is the response object from the GetPatchBaseline operation.

Class HierarchyLevelLimitExceededException

SimpleSystemsManagement exception

Class HierarchyTypeMismatchException

SimpleSystemsManagement exception

Class IdempotentParameterMismatchException

SimpleSystemsManagement exception

Class InstanceAggregatedAssociationOverview

Status information about the aggregated associations.

Class InstanceAssociation

One or more association documents on the instance.

Class InstanceAssociationOutputLocation

An Amazon S3 bucket where you want to store the results of this request.

Class InstanceAssociationOutputUrl

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

Class InstanceAssociationStatusInfo

Status information about the instance association.

Class InstanceInformation

Describes a filter for a specific list of instances.

Class InstanceInformationFilter

Describes a filter for a specific list of instances.

Class InstanceInformationStringFilter

The filters to describe or get information about your managed instances.

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

Class InstancePatchStateFilter

Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the information returned by the API.

Class InternalServerErrorException

SimpleSystemsManagement exception

Class InvalidActivationException

SimpleSystemsManagement exception

Class InvalidActivationIdException

SimpleSystemsManagement exception

Class InvalidAllowedPatternException

SimpleSystemsManagement exception

Class InvalidAssociationVersionException

SimpleSystemsManagement exception

Class InvalidAutomationExecutionParametersException

SimpleSystemsManagement exception

Class InvalidAutomationSignalException

SimpleSystemsManagement exception

Class InvalidCommandIdException

SimpleSystemsManagement exception

Class InvalidDocumentContentException

SimpleSystemsManagement exception

Class InvalidDocumentException

SimpleSystemsManagement exception

Class InvalidDocumentOperationException

SimpleSystemsManagement exception

Class InvalidDocumentSchemaVersionException

SimpleSystemsManagement exception

Class InvalidDocumentVersionException

SimpleSystemsManagement exception

Class InvalidFilterException

SimpleSystemsManagement exception

Class InvalidFilterKeyException

SimpleSystemsManagement exception

Class InvalidFilterOptionException

SimpleSystemsManagement exception

Class InvalidFilterValueException

SimpleSystemsManagement exception

Class InvalidInstanceIdException

SimpleSystemsManagement exception

Class InvalidInstanceInformationFilterValueException

SimpleSystemsManagement exception

Class InvalidInventoryItemContextException

SimpleSystemsManagement exception

Class InvalidItemContentException

SimpleSystemsManagement exception

Class InvalidKeyIdException

SimpleSystemsManagement exception

Class InvalidNextTokenException

SimpleSystemsManagement exception

Class InvalidNotificationConfigException

SimpleSystemsManagement exception

Class InvalidOutputFolderException

SimpleSystemsManagement exception

Class InvalidOutputLocationException

SimpleSystemsManagement exception

Class InvalidParametersException

SimpleSystemsManagement exception

Class InvalidPermissionTypeException

SimpleSystemsManagement exception

Class InvalidPluginNameException

SimpleSystemsManagement exception

Class InvalidResourceIdException

SimpleSystemsManagement exception

Class InvalidResourceTypeException

SimpleSystemsManagement exception

Class InvalidResultAttributeException

SimpleSystemsManagement exception

Class InvalidRoleException

SimpleSystemsManagement exception

Class InvalidScheduleException

SimpleSystemsManagement exception

Class InvalidTargetException

SimpleSystemsManagement exception

Class InvalidTypeNameException

SimpleSystemsManagement exception

Class InvalidUpdateException

SimpleSystemsManagement exception

Class InventoryFilter

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

Class InventoryItem

Information collected from managed instances based on your inventory policy document

Class InventoryItemAttribute

Attributes are the entries within the inventory item content. It contains name and value.

Class InventoryItemSchema

The inventory item schema definition. Users can use this to compose inventory query filters.

Class InventoryResultEntity

Inventory query results.

Class InventoryResultItem

The inventory result item.

Class InvocationDoesNotExistException

SimpleSystemsManagement exception

Class ItemContentMismatchException

SimpleSystemsManagement exception

Class ItemSizeLimitExceededException

SimpleSystemsManagement exception

Class ListAssociationsRequest

Container for the parameters to the ListAssociations operation. Lists the associations for the specified Systems Manager document or instance.

Class ListAssociationsResponse

This is the response object from the ListAssociations operation.

Class ListAssociationVersionsRequest

Container for the parameters to the ListAssociationVersions operation. Retrieves all versions of an association for a specific association ID.

Class ListAssociationVersionsResponse

This is the response object from the ListAssociationVersions operation.

Class ListCommandInvocationsRequest

Container for the parameters to the ListCommandInvocations operation. An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

Class ListCommandInvocationsResponse

This is the response object from the ListCommandInvocations operation.

Class ListCommandsRequest

Container for the parameters to the ListCommands operation. Lists the commands requested by users of the AWS account.

Class ListCommandsResponse

This is the response object from the ListCommands operation.

Class ListComplianceItemsRequest

Container for the parameters to the ListComplianceItems operation. For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

Class ListComplianceItemsResponse

This is the response object from the ListComplianceItems operation.

Class ListComplianceSummariesRequest

Container for the parameters to the ListComplianceSummaries operation. Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

Class ListComplianceSummariesResponse

This is the response object from the ListComplianceSummaries operation.

Class ListDocumentsRequest

Container for the parameters to the ListDocuments operation. Describes one or more of your Systems Manager documents.

Class ListDocumentsResponse

This is the response object from the ListDocuments operation.

Class ListDocumentVersionsRequest

Container for the parameters to the ListDocumentVersions operation. List all versions for a document.

Class ListDocumentVersionsResponse

This is the response object from the ListDocumentVersions operation.

Class ListInventoryEntriesRequest

Container for the parameters to the ListInventoryEntries operation. A list of inventory items returned by the request.

Class ListInventoryEntriesResponse

This is the response object from the ListInventoryEntries operation.

Class ListResourceComplianceSummariesRequest

Container for the parameters to the ListResourceComplianceSummaries operation. Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

Class ListResourceComplianceSummariesResponse

This is the response object from the ListResourceComplianceSummaries operation.

Class ListResourceDataSyncRequest

Container for the parameters to the ListResourceDataSync operation. Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

Class ListResourceDataSyncResponse

This is the response object from the ListResourceDataSync operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Returns a list of the tags assigned to the specified resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class LoggingInfo

Information about an Amazon S3 bucket to write instance-level logs to.

Class MaintenanceWindowAutomationParameters

The parameters for an AUTOMATION task type.

Class MaintenanceWindowExecution

Describes the information about an execution of a Maintenance Window.

Class MaintenanceWindowExecutionTaskIdentity

Information about a task execution performed as part of a Maintenance Window execution.

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

Class MaintenanceWindowFilter

Filter used in the request.

Class MaintenanceWindowIdentity

Information about the Maintenance Window.

Class MaintenanceWindowLambdaParameters

The parameters for a LAMBDA task type.

Class MaintenanceWindowRunCommandParameters

The parameters for a RUN_COMMAND task type.

Class MaintenanceWindowStepFunctionsParameters

The parameters for the STEP_FUNCTION execution.

Class MaintenanceWindowTarget

The target registered with the Maintenance Window.

Class MaintenanceWindowTask

Information about a task defined for a Maintenance Window.

Class MaintenanceWindowTaskInvocationParameters

The parameters for task execution.

Class MaintenanceWindowTaskParameterValueExpression

Defines the values for a task parameter.

Class MaxDocumentSizeExceededException

SimpleSystemsManagement exception

Class ModifyDocumentPermissionRequest

Container for the parameters to the ModifyDocumentPermission operation. Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

Class ModifyDocumentPermissionResponse

This is the response object from the ModifyDocumentPermission operation.

Class NonCompliantSummary

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

Class NotificationConfig

Configurations for sending notifications.

Class Parameter

An Amazon EC2 Systems Manager parameter in Parameter Store.

Class ParameterAlreadyExistsException

SimpleSystemsManagement exception

Class ParameterHistory

Information about parameter usage.

Class ParameterLimitExceededException

SimpleSystemsManagement exception

Class ParameterMetadata

Metada includes information like the ARN of the last user and the date/time the parameter was last used.

Class ParameterNotFoundException

SimpleSystemsManagement exception

Class ParameterPatternMismatchException

SimpleSystemsManagement exception

Class ParametersFilter

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

Class ParameterStringFilter

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

Class Patch

Represents metadata about a patch.

Class PatchBaselineIdentity

Defines the basic information about a patch baseline.

Class PatchComplianceData

Information about the state of a patch on a particular instance as it relates to the patch baseline used to patch the instance.

Class PatchFilter

Defines a patch filter.

Class PatchFilterGroup

A set of patch filters, typically used for approval rules.

Class PatchGroupPatchBaselineMapping

The mapping between a patch group and the patch baseline the patch group is registered with.

Class PatchOrchestratorFilter

Defines a filter used in Patch Manager APIs.

Class PatchRule

Defines an approval rule for a patch baseline.

Class PatchRuleGroup

A set of rules defining the approval rules for a patch baseline.

Class PatchStatus

Information about the approval status of a patch.

Class PutComplianceItemsRequest

Container for the parameters to the PutComplianceItems operation. Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

Class PutComplianceItemsResponse

This is the response object from the PutComplianceItems operation.

Class PutInventoryRequest

Container for the parameters to the PutInventory operation. Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

Class PutInventoryResponse

This is the response object from the PutInventory operation.

Class PutParameterRequest

Container for the parameters to the PutParameter operation. Add one or more parameters to the system.

Class PutParameterResponse

This is the response object from the PutParameter operation.

Class RegisterDefaultPatchBaselineRequest

Container for the parameters to the RegisterDefaultPatchBaseline operation. Defines the default patch baseline.

Class RegisterDefaultPatchBaselineResponse

This is the response object from the RegisterDefaultPatchBaseline operation.

Class RegisterPatchBaselineForPatchGroupRequest

Container for the parameters to the RegisterPatchBaselineForPatchGroup operation. Registers a patch baseline for a patch group.

Class RegisterPatchBaselineForPatchGroupResponse

This is the response object from the RegisterPatchBaselineForPatchGroup operation.

Class RegisterTargetWithMaintenanceWindowRequest

Container for the parameters to the RegisterTargetWithMaintenanceWindow operation. Registers a target with a Maintenance Window.

Class RegisterTargetWithMaintenanceWindowResponse

This is the response object from the RegisterTargetWithMaintenanceWindow operation.

Class RegisterTaskWithMaintenanceWindowRequest

Container for the parameters to the RegisterTaskWithMaintenanceWindow operation. Adds a new task to a Maintenance Window.

Class RegisterTaskWithMaintenanceWindowResponse

This is the response object from the RegisterTaskWithMaintenanceWindow operation.

Class RemoveTagsFromResourceRequest

Container for the parameters to the RemoveTagsFromResource operation. Removes all tags from the specified resource.

Class RemoveTagsFromResourceResponse

This is the response object from the RemoveTagsFromResource operation.

Class ResourceComplianceSummaryItem

Compliance summary information for a specific resource.

Class ResourceDataSyncAlreadyExistsException

SimpleSystemsManagement exception

Class ResourceDataSyncCountExceededException

SimpleSystemsManagement exception

Class ResourceDataSyncInvalidConfigurationException

SimpleSystemsManagement exception

Class ResourceDataSyncItem

Information about a Resource Data Sync configuration, including its current status and last successful sync.

Class ResourceDataSyncNotFoundException

SimpleSystemsManagement exception

Class ResourceDataSyncS3Destination

Information about the target Amazon S3 bucket for the Resource Data Sync.

Class ResourceInUseException

SimpleSystemsManagement exception

Class ResourceLimitExceededException

SimpleSystemsManagement exception

Class ResultAttribute

The inventory item result attribute.

Class S3OutputLocation

An Amazon S3 bucket where you want to store the results of this request.

Class S3OutputUrl

A URL for the Amazon S3 bucket where you want to store the results of this request.

Class SendAutomationSignalRequest

Container for the parameters to the SendAutomationSignal operation. Sends a signal to an Automation execution to change the current behavior or status of the execution.

Class SendAutomationSignalResponse

This is the response object from the SendAutomationSignal operation.

Class SendCommandRequest

Container for the parameters to the SendCommand operation. Executes commands on one or more managed instances.

Class SendCommandResponse

This is the response object from the SendCommand operation.

Class SeveritySummary

The number of managed instances found for each patch severity level defined in the request filter.

Class StartAutomationExecutionRequest

Container for the parameters to the StartAutomationExecution operation. Initiates execution of an Automation document.

Class StartAutomationExecutionResponse

This is the response object from the StartAutomationExecution operation.

Class StatusUnchangedException

SimpleSystemsManagement exception

Class StepExecution

Detailed information about an the execution state of an Automation step.

Class StopAutomationExecutionRequest

Container for the parameters to the StopAutomationExecution operation. Stop an Automation that is currently executing.

Class StopAutomationExecutionResponse

This is the response object from the StopAutomationExecution operation.

Class SubTypeCountLimitExceededException

SimpleSystemsManagement exception

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

Class Target

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.

Class TargetInUseException

SimpleSystemsManagement exception

Class TooManyTagsErrorException

SimpleSystemsManagement exception

Class TooManyUpdatesException

SimpleSystemsManagement exception

Class TotalSizeLimitExceededException

SimpleSystemsManagement exception

Class UnsupportedInventoryItemContextException

SimpleSystemsManagement exception

Class UnsupportedInventorySchemaVersionException

SimpleSystemsManagement exception

Class UnsupportedOperatingSystemException

SimpleSystemsManagement exception

Class UnsupportedParameterTypeException

SimpleSystemsManagement exception

Class UnsupportedPlatformTypeException

SimpleSystemsManagement exception

Class UpdateAssociationRequest

Container for the parameters to the UpdateAssociation operation. Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

Class UpdateAssociationResponse

This is the response object from the UpdateAssociation operation.

Class UpdateAssociationStatusRequest

Container for the parameters to the UpdateAssociationStatus operation. Updates the status of the Systems Manager document associated with the specified instance.

Class UpdateAssociationStatusResponse

This is the response object from the UpdateAssociationStatus operation.

Class UpdateDocumentDefaultVersionRequest

Container for the parameters to the UpdateDocumentDefaultVersion operation. Set the default version of a document.

Class UpdateDocumentDefaultVersionResponse

This is the response object from the UpdateDocumentDefaultVersion operation.

Class UpdateDocumentRequest

Container for the parameters to the UpdateDocument operation. The document you want to update.

Class UpdateDocumentResponse

This is the response object from the UpdateDocument operation.

Class UpdateMaintenanceWindowRequest

Container for the parameters to the UpdateMaintenanceWindow operation. Updates an existing Maintenance Window. Only specified parameters are modified.

Class UpdateMaintenanceWindowResponse

This is the response object from the UpdateMaintenanceWindow operation.

Class UpdateMaintenanceWindowTargetRequest

Container for the parameters to the UpdateMaintenanceWindowTarget operation. Modifies the target of an existing Maintenance Window. You can't change the target type, but you can change the following:

The target from being an ID target to a Tag target, or a Tag target to an ID target.

IDs for an ID target.

Tags for a Tag target.

Owner.

Name.

Description.

If a parameter is null, then the corresponding field is not modified.

Class UpdateMaintenanceWindowTargetResponse

This is the response object from the UpdateMaintenanceWindowTarget operation.

Class UpdateMaintenanceWindowTaskRequest

Container for the parameters to the UpdateMaintenanceWindowTask operation. Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following values:

Task ARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

Service role ARN.

Task parameters.

Task priority.

Task MaxConcurrency and MaxErrors.

Log location.

If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

Class UpdateMaintenanceWindowTaskResponse

This is the response object from the UpdateMaintenanceWindowTask operation.

Class UpdateManagedInstanceRoleRequest

Container for the parameters to the UpdateManagedInstanceRole operation. Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

Class UpdateManagedInstanceRoleResponse

This is the response object from the UpdateManagedInstanceRole operation.

Class UpdatePatchBaselineRequest

Container for the parameters to the UpdatePatchBaseline operation. Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

Class UpdatePatchBaselineResponse

This is the response object from the UpdatePatchBaseline operation.