SsmClient Class

Member Function Documentation

SsmClient::SsmClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a SsmClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

SsmClient::SsmClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads SsmClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddTagsToResourceResponse *SsmClient::addTagsToResource(const AddTagsToResourceRequest &request)

Sends request to the SsmClient service, and returns a pointer to an AddTagsToResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 50 tags.

</p

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.

</p

For more information about tags, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging Your Amazon EC2 Resources</a> in the <i>Amazon EC2 User

[slot] CancelCommandResponse *SsmClient::cancelCommand(const CancelCommandRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CancelCommandResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process

[slot] CreateActivationResponse *SsmClient::createActivation(const CreateActivationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CreateActivationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html">Setting Up Systems Manager in Hybrid

[slot] CreateAssociationResponse *SsmClient::createAssociation(const CreateAssociationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CreateAssociationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateAssociationBatchResponse *SsmClient::createAssociationBatch(const CreateAssociationBatchRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CreateAssociationBatchResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateDocumentResponse *SsmClient::createDocument(const CreateDocumentRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CreateDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a Systems Manager

document>

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

[slot] CreateMaintenanceWindowResponse *SsmClient::createMaintenanceWindow(const CreateMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CreateMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new Maintenance

[slot] CreatePatchBaselineResponse *SsmClient::createPatchBaseline(const CreatePatchBaselineRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CreatePatchBaselineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a patch

baseline> <note>

For information about valid key and value pairs in <code>PatchFilters</code> for each supported operating system type, see <a

[slot] CreateResourceDataSyncResponse *SsmClient::createResourceDataSync(const CreateResourceDataSyncRequest &request)

Sends request to the SsmClient service, and returns a pointer to an CreateResourceDataSyncResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

<a>ListResourceDataSync</a>>

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 <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync">Configuring Resource Data Sync for

[slot] DeleteActivationResponse *SsmClient::deleteActivation(const DeleteActivationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteActivationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteAssociationResponse *SsmClient::deleteAssociation(const DeleteAssociationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteAssociationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteDocumentResponse *SsmClient::deleteDocument(const DeleteDocumentRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes the Systems Manager document and all instance associations to the

document>

Before you delete the document, we recommend that you use <a>DeleteAssociation</a> to disassociate all instances that are associated with the

[slot] DeleteInventoryResponse *SsmClient::deleteInventory(const DeleteInventoryRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteInventoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory

[slot] DeleteMaintenanceWindowResponse *SsmClient::deleteMaintenanceWindow(const DeleteMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a Maintenance

[slot] DeleteParameterResponse *SsmClient::deleteParameter(const DeleteParameterRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteParameterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Delete a parameter from the

[slot] DeleteParametersResponse *SsmClient::deleteParameters(const DeleteParametersRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteParametersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Delete a list of parameters. This API is used to delete parameters by using the Amazon EC2

[slot] DeletePatchBaselineResponse *SsmClient::deletePatchBaseline(const DeletePatchBaselineRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeletePatchBaselineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a patch

[slot] DeleteResourceDataSyncResponse *SsmClient::deleteResourceDataSync(const DeleteResourceDataSyncRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeleteResourceDataSyncResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeregisterManagedInstanceResponse *SsmClient::deregisterManagedInstance(const DeregisterManagedInstanceRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeregisterManagedInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeregisterPatchBaselineForPatchGroupResponse *SsmClient::deregisterPatchBaselineForPatchGroup(const DeregisterPatchBaselineForPatchGroupRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeregisterPatchBaselineForPatchGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes a patch group from a patch

[slot] DeregisterTargetFromMaintenanceWindowResponse *SsmClient::deregisterTargetFromMaintenanceWindow(const DeregisterTargetFromMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeregisterTargetFromMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes a target from a Maintenance

[slot] DeregisterTaskFromMaintenanceWindowResponse *SsmClient::deregisterTaskFromMaintenanceWindow(const DeregisterTaskFromMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DeregisterTaskFromMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes a task from a Maintenance

[slot] DescribeActivationsResponse *SsmClient::describeActivations(const DescribeActivationsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeActivationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeAssociationResponse *SsmClient::describeAssociation(const DescribeAssociationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeAssociationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the association for the specified target or instance. If you created the association by using the <code>Targets</code> parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.

[slot] DescribeAutomationExecutionsResponse *SsmClient::describeAutomationExecutions(const DescribeAutomationExecutionsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeAutomationExecutionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides details about all active and terminated Automation

[slot] DescribeAutomationStepExecutionsResponse *SsmClient::describeAutomationStepExecutions(const DescribeAutomationStepExecutionsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeAutomationStepExecutionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Information about all active and terminated step executions in an Automation

[slot] DescribeAvailablePatchesResponse *SsmClient::describeAvailablePatches(const DescribeAvailablePatchesRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeAvailablePatchesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all patches that could possibly be included in a patch

[slot] DescribeDocumentResponse *SsmClient::describeDocument(const DescribeDocumentRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes the specified Systems Manager

[slot] DescribeDocumentPermissionResponse *SsmClient::describeDocumentPermission(const DescribeDocumentPermissionRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeDocumentPermissionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 (<i>All</i>).

[slot] DescribeEffectiveInstanceAssociationsResponse *SsmClient::describeEffectiveInstanceAssociations(const DescribeEffectiveInstanceAssociationsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeEffectiveInstanceAssociationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

All associations for the

[slot] DescribeEffectivePatchesForPatchBaselineResponse *SsmClient::describeEffectivePatchesForPatchBaseline(const DescribeEffectivePatchesForPatchBaselineRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeEffectivePatchesForPatchBaselineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeInstanceAssociationsStatusResponse *SsmClient::describeInstanceAssociationsStatus(const DescribeInstanceAssociationsStatusRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeInstanceAssociationsStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The status of the associations for the

[slot] DescribeInstanceInformationResponse *SsmClient::describeInstanceInformation(const DescribeInstanceInformationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeInstanceInformationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

[slot] DescribeInstancePatchStatesResponse *SsmClient::describeInstancePatchStates(const DescribeInstancePatchStatesRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeInstancePatchStatesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the high-level patch state of one or more

[slot] DescribeInstancePatchStatesForPatchGroupResponse *SsmClient::describeInstancePatchStatesForPatchGroup(const DescribeInstancePatchStatesForPatchGroupRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeInstancePatchStatesForPatchGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the high-level patch state for the instances in the specified patch

[slot] DescribeInstancePatchesResponse *SsmClient::describeInstancePatches(const DescribeInstancePatchesRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeInstancePatchesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the

[slot] DescribeInventoryDeletionsResponse *SsmClient::describeInventoryDeletions(const DescribeInventoryDeletionsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeInventoryDeletionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes a specific delete inventory

[slot] DescribeMaintenanceWindowExecutionTaskInvocationsResponse *SsmClient::describeMaintenanceWindowExecutionTaskInvocations(const DescribeMaintenanceWindowExecutionTaskInvocationsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeMaintenanceWindowExecutionTaskInvocationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window

[slot] DescribeMaintenanceWindowExecutionTasksResponse *SsmClient::describeMaintenanceWindowExecutionTasks(const DescribeMaintenanceWindowExecutionTasksRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeMaintenanceWindowExecutionTasksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

For a given Maintenance Window execution, lists the tasks that were

[slot] DescribeMaintenanceWindowExecutionsResponse *SsmClient::describeMaintenanceWindowExecutions(const DescribeMaintenanceWindowExecutionsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeMaintenanceWindowExecutionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeMaintenanceWindowTargetsResponse *SsmClient::describeMaintenanceWindowTargets(const DescribeMaintenanceWindowTargetsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeMaintenanceWindowTargetsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the targets registered with the Maintenance

[slot] DescribeMaintenanceWindowTasksResponse *SsmClient::describeMaintenanceWindowTasks(const DescribeMaintenanceWindowTasksRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeMaintenanceWindowTasksResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the tasks in a Maintenance

[slot] DescribeMaintenanceWindowsResponse *SsmClient::describeMaintenanceWindows(const DescribeMaintenanceWindowsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeMaintenanceWindowsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the Maintenance Windows in an AWS

[slot] DescribeParametersResponse *SsmClient::describeParameters(const DescribeParametersRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribeParametersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get information about a

parameter>

Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> 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 <code>MaxResults</code>. 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 <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of

[slot] DescribePatchBaselinesResponse *SsmClient::describePatchBaselines(const DescribePatchBaselinesRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribePatchBaselinesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the patch baselines in your AWS

[slot] DescribePatchGroupStateResponse *SsmClient::describePatchGroupState(const DescribePatchGroupStateRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribePatchGroupStateResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns high-level aggregated patch compliance state for a patch

[slot] DescribePatchGroupsResponse *SsmClient::describePatchGroups(const DescribePatchGroupsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an DescribePatchGroupsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all patch groups that have been registered with patch

[slot] GetAutomationExecutionResponse *SsmClient::getAutomationExecution(const GetAutomationExecutionRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetAutomationExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get detailed information about a particular Automation

[slot] GetCommandInvocationResponse *SsmClient::getCommandInvocation(const GetCommandInvocationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetCommandInvocationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns detailed information about command execution for an invocation or plugin.

[slot] GetDefaultPatchBaselineResponse *SsmClient::getDefaultPatchBaseline(const GetDefaultPatchBaselineRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetDefaultPatchBaselineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

If you do not specify an operating system value, the default patch baseline for Windows is

[slot] GetDeployablePatchSnapshotForInstanceResponse *SsmClient::getDeployablePatchSnapshotForInstance(const GetDeployablePatchSnapshotForInstanceRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetDeployablePatchSnapshotForInstanceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetDocumentResponse *SsmClient::getDocument(const GetDocumentRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets the contents of the specified Systems Manager

[slot] GetInventoryResponse *SsmClient::getInventory(const GetInventoryRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetInventoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Query inventory

[slot] GetInventorySchemaResponse *SsmClient::getInventorySchema(const GetInventorySchemaRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetInventorySchemaResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

[slot] GetMaintenanceWindowResponse *SsmClient::getMaintenanceWindow(const GetMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves a Maintenance

[slot] GetMaintenanceWindowExecutionResponse *SsmClient::getMaintenanceWindowExecution(const GetMaintenanceWindowExecutionRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetMaintenanceWindowExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves details about a specific task executed as part of a Maintenance Window

[slot] GetMaintenanceWindowExecutionTaskResponse *SsmClient::getMaintenanceWindowExecutionTask(const GetMaintenanceWindowExecutionTaskRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetMaintenanceWindowExecutionTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the details about a specific task executed as part of a Maintenance Window

[slot] GetMaintenanceWindowExecutionTaskInvocationResponse *SsmClient::getMaintenanceWindowExecutionTaskInvocation(const GetMaintenanceWindowExecutionTaskInvocationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetMaintenanceWindowExecutionTaskInvocationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves a task invocation. A task invocation is a specific task executing on a specific target. Maintenance Windows report status for all invocations.

[slot] GetMaintenanceWindowTaskResponse *SsmClient::getMaintenanceWindowTask(const GetMaintenanceWindowTaskRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetMaintenanceWindowTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the tasks in a Maintenance

[slot] GetParameterResponse *SsmClient::getParameter(const GetParameterRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetParameterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get information about a parameter by using the parameter name.

[slot] GetParameterHistoryResponse *SsmClient::getParameterHistory(const GetParameterHistoryRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetParameterHistoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Query a list of all parameters used by the AWS

[slot] GetParametersResponse *SsmClient::getParameters(const GetParametersRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetParametersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Get details of a

[slot] GetParametersByPathResponse *SsmClient::getParametersByPath(const GetParametersByPathRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetParametersByPathResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieve parameters in a specific hierarchy. For more information, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-working.html">Working with Systems Manager Parameters</a>.

</p

Request results are returned on a best-effort basis. If you specify <code>MaxResults</code> 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 <code>MaxResults</code>. 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 <code>NextToken</code>. You can specify the <code>NextToken</code> in a subsequent call to get the next set of

results> <note>

This API action doesn't support filtering by tags.

[slot] GetPatchBaselineResponse *SsmClient::getPatchBaseline(const GetPatchBaselineRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetPatchBaselineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves information about a patch

[slot] GetPatchBaselineForPatchGroupResponse *SsmClient::getPatchBaselineForPatchGroup(const GetPatchBaselineForPatchGroupRequest &request)

Sends request to the SsmClient service, and returns a pointer to an GetPatchBaselineForPatchGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the patch baseline that should be used for the specified patch

[slot] ListAssociationVersionsResponse *SsmClient::listAssociationVersions(const ListAssociationVersionsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListAssociationVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves all versions of an association for a specific association

[slot] ListAssociationsResponse *SsmClient::listAssociations(const ListAssociationsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListAssociationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the associations for the specified Systems Manager document or

[slot] ListCommandInvocationsResponse *SsmClient::listCommandInvocations(const ListCommandInvocationsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListCommandInvocationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListCommandsResponse *SsmClient::listCommands(const ListCommandsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListCommandsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the commands requested by users of the AWS

[slot] ListComplianceItemsResponse *SsmClient::listComplianceItems(const ListComplianceItemsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListComplianceItemsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

[slot] ListComplianceSummariesResponse *SsmClient::listComplianceSummaries(const ListComplianceSummariesRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListComplianceSummariesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

[slot] ListDocumentVersionsResponse *SsmClient::listDocumentVersions(const ListDocumentVersionsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListDocumentVersionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

List all versions for a

[slot] ListDocumentsResponse *SsmClient::listDocuments(const ListDocumentsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListDocumentsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Describes one or more of your Systems Manager

[slot] ListInventoryEntriesResponse *SsmClient::listInventoryEntries(const ListInventoryEntriesRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListInventoryEntriesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

A list of inventory items returned by the

[slot] ListResourceComplianceSummariesResponse *SsmClient::listResourceComplianceSummaries(const ListResourceComplianceSummariesRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListResourceComplianceSummariesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListResourceDataSyncResponse *SsmClient::listResourceDataSync(const ListResourceDataSyncRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListResourceDataSyncResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>ListResourceDataSync</code>. You can limit the number of sync configurations returned by using the <code>MaxResults</code> parameter. To determine whether there are more sync configurations to list, check the value of <code>NextToken</code> in the output. If there are more sync configurations to list, you can request them by specifying the <code>NextToken</code> returned in the call to the parameter of a subsequent call.

[slot] ListTagsForResourceResponse *SsmClient::listTagsForResource(const ListTagsForResourceRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns a list of the tags assigned to the specified

[slot] ModifyDocumentPermissionResponse *SsmClient::modifyDocumentPermission(const ModifyDocumentPermissionRequest &request)

Sends request to the SsmClient service, and returns a pointer to an ModifyDocumentPermissionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <i>All</i> as the account

[slot] PutComplianceItemsResponse *SsmClient::putComplianceItems(const PutComplianceItemsRequest &request)

Sends request to the SsmClient service, and returns a pointer to an PutComplianceItemsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

ComplianceType can be one of the

following> <ul> <li>

ExecutionId: The execution ID when the patch, association, or custom compliance item was

applied> </li> <li>

ExecutionType: Specify patch, association, or

Custom:<code>string</code>> </li> <li>

ExecutionTime. The time the patch, association, or custom compliance item was applied to the

instance> </li> <li>

Id: The patch, association, or custom compliance

ID> </li> <li>

Title: A

title> </li> <li>

Status: The status of the compliance item. For example, <code>approved</code> for patches, or <code>Failed</code> for

associations> </li> <li>

Severity: A patch severity. For example,

<code>critical</code>> </li> <li>

DocumentName: A SSM document name. For example,

AWS-RunPatchBaseline> </li> <li>

DocumentVersion: An SSM document version number. For example,

4> </li> <li>

Classification: A patch classification. For example, <code>security

updates</code>> </li> <li>

PatchBaselineId: A patch baseline

ID> </li> <li>

PatchSeverity: A patch severity. For example,

<code>Critical</code>> </li> <li>

PatchState: A patch state. For example,

<code>InstancesWithFailedPatches</code>> </li> <li>

PatchGroup: The name of a patch

group> </li> <li>

InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format:

[slot] PutInventoryResponse *SsmClient::putInventory(const PutInventoryRequest &request)

Sends request to the SsmClient service, and returns a pointer to an PutInventoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] PutParameterResponse *SsmClient::putParameter(const PutParameterRequest &request)

Sends request to the SsmClient service, and returns a pointer to an PutParameterResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Add a parameter to the

[slot] RegisterDefaultPatchBaselineResponse *SsmClient::registerDefaultPatchBaseline(const RegisterDefaultPatchBaselineRequest &request)

Sends request to the SsmClient service, and returns a pointer to an RegisterDefaultPatchBaselineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Defines the default patch

[slot] RegisterPatchBaselineForPatchGroupResponse *SsmClient::registerPatchBaselineForPatchGroup(const RegisterPatchBaselineForPatchGroupRequest &request)

Sends request to the SsmClient service, and returns a pointer to an RegisterPatchBaselineForPatchGroupResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers a patch baseline for a patch

[slot] RegisterTargetWithMaintenanceWindowResponse *SsmClient::registerTargetWithMaintenanceWindow(const RegisterTargetWithMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an RegisterTargetWithMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Registers a target with a Maintenance

[slot] RegisterTaskWithMaintenanceWindowResponse *SsmClient::registerTaskWithMaintenanceWindow(const RegisterTaskWithMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an RegisterTaskWithMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Adds a new task to a Maintenance

[slot] RemoveTagsFromResourceResponse *SsmClient::removeTagsFromResource(const RemoveTagsFromResourceRequest &request)

Sends request to the SsmClient service, and returns a pointer to an RemoveTagsFromResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes all tags from the specified

[slot] SendAutomationSignalResponse *SsmClient::sendAutomationSignal(const SendAutomationSignalRequest &request)

Sends request to the SsmClient service, and returns a pointer to an SendAutomationSignalResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Sends a signal to an Automation execution to change the current behavior or status of the execution.

[slot] SendCommandResponse *SsmClient::sendCommand(const SendCommandRequest &request)

Sends request to the SsmClient service, and returns a pointer to an SendCommandResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Executes commands on one or more managed

[slot] StartAutomationExecutionResponse *SsmClient::startAutomationExecution(const StartAutomationExecutionRequest &request)

Sends request to the SsmClient service, and returns a pointer to an StartAutomationExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Initiates execution of an Automation

[slot] StopAutomationExecutionResponse *SsmClient::stopAutomationExecution(const StopAutomationExecutionRequest &request)

Sends request to the SsmClient service, and returns a pointer to an StopAutomationExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Stop an Automation that is currently

[slot] UpdateAssociationResponse *SsmClient::updateAssociation(const UpdateAssociationRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateAssociationResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3

[slot] UpdateAssociationStatusResponse *SsmClient::updateAssociationStatus(const UpdateAssociationStatusRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateAssociationStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the status of the Systems Manager document associated with the specified

[slot] UpdateDocumentResponse *SsmClient::updateDocument(const UpdateDocumentRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateDocumentResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The document you want to

[slot] UpdateDocumentDefaultVersionResponse *SsmClient::updateDocumentDefaultVersion(const UpdateDocumentDefaultVersionRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateDocumentDefaultVersionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Set the default version of a document.

[slot] UpdateMaintenanceWindowResponse *SsmClient::updateMaintenanceWindow(const UpdateMaintenanceWindowRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateMaintenanceWindowResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates an existing Maintenance Window. Only specified parameters are

[slot] UpdateMaintenanceWindowTargetResponse *SsmClient::updateMaintenanceWindowTarget(const UpdateMaintenanceWindowTargetRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateMaintenanceWindowTargetResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateMaintenanceWindowTaskResponse *SsmClient::updateMaintenanceWindowTask(const UpdateMaintenanceWindowTaskRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateMaintenanceWindowTaskResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies a task assigned to a Maintenance Window. You can't change the task type, but you can change the following

values> <ul> <li>

TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to

AWS-RunShellScript> </li> <li>

ServiceRoleAr> </li> <li>

TaskInvocationParameter> </li> <li>

Priorit> </li> <li>

MaxConcurrenc> </li> <li>

MaxError> </li> </ul>

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 <a>RegisterTaskWithMaintenanceWindow</a> action are required for this request. Optional fields that aren't specified are set to

[slot] UpdateManagedInstanceRoleResponse *SsmClient::updateManagedInstanceRole(const UpdateManagedInstanceRoleRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdateManagedInstanceRoleResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed

[slot] UpdatePatchBaselineResponse *SsmClient::updatePatchBaseline(const UpdatePatchBaselineRequest &request)

Sends request to the SsmClient service, and returns a pointer to an UpdatePatchBaselineResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies an existing patch baseline. Fields not specified in the request are left

unchanged> <note>

For information about valid key and value pairs in <code>PatchFilters</code> for each supported operating system type, see <a