[−][src]Trait rusoto_ssm::Ssm

pub trait Ssm {
    fn add_tags_to_resource(
        &self, 
        input: AddTagsToResourceRequest
    ) -> RusotoFuture<AddTagsToResourceResult, AddTagsToResourceError>;

    fn cancel_command(
        &self, 
        input: CancelCommandRequest
    ) -> RusotoFuture<CancelCommandResult, CancelCommandError>;

    fn create_activation(
        &self, 
        input: CreateActivationRequest
    ) -> RusotoFuture<CreateActivationResult, CreateActivationError>;

    fn create_association(
        &self, 
        input: CreateAssociationRequest
    ) -> RusotoFuture<CreateAssociationResult, CreateAssociationError>;

    fn create_association_batch(
        &self, 
        input: CreateAssociationBatchRequest
    ) -> RusotoFuture<CreateAssociationBatchResult, CreateAssociationBatchError>;

    fn create_document(
        &self, 
        input: CreateDocumentRequest
    ) -> RusotoFuture<CreateDocumentResult, CreateDocumentError>;

    fn create_maintenance_window(
        &self, 
        input: CreateMaintenanceWindowRequest
    ) -> RusotoFuture<CreateMaintenanceWindowResult, CreateMaintenanceWindowError>;

    fn create_patch_baseline(
        &self, 
        input: CreatePatchBaselineRequest
    ) -> RusotoFuture<CreatePatchBaselineResult, CreatePatchBaselineError>;

    fn create_resource_data_sync(
        &self, 
        input: CreateResourceDataSyncRequest
    ) -> RusotoFuture<CreateResourceDataSyncResult, CreateResourceDataSyncError>;

    fn delete_activation(
        &self, 
        input: DeleteActivationRequest
    ) -> RusotoFuture<DeleteActivationResult, DeleteActivationError>;

    fn delete_association(
        &self, 
        input: DeleteAssociationRequest
    ) -> RusotoFuture<DeleteAssociationResult, DeleteAssociationError>;

    fn delete_document(
        &self, 
        input: DeleteDocumentRequest
    ) -> RusotoFuture<DeleteDocumentResult, DeleteDocumentError>;

    fn delete_inventory(
        &self, 
        input: DeleteInventoryRequest
    ) -> RusotoFuture<DeleteInventoryResult, DeleteInventoryError>;

    fn delete_maintenance_window(
        &self, 
        input: DeleteMaintenanceWindowRequest
    ) -> RusotoFuture<DeleteMaintenanceWindowResult, DeleteMaintenanceWindowError>;

    fn delete_parameter(
        &self, 
        input: DeleteParameterRequest
    ) -> RusotoFuture<DeleteParameterResult, DeleteParameterError>;

    fn delete_parameters(
        &self, 
        input: DeleteParametersRequest
    ) -> RusotoFuture<DeleteParametersResult, DeleteParametersError>;

    fn delete_patch_baseline(
        &self, 
        input: DeletePatchBaselineRequest
    ) -> RusotoFuture<DeletePatchBaselineResult, DeletePatchBaselineError>;

    fn delete_resource_data_sync(
        &self, 
        input: DeleteResourceDataSyncRequest
    ) -> RusotoFuture<DeleteResourceDataSyncResult, DeleteResourceDataSyncError>;

    fn deregister_managed_instance(
        &self, 
        input: DeregisterManagedInstanceRequest
    ) -> RusotoFuture<DeregisterManagedInstanceResult, DeregisterManagedInstanceError>;

    fn deregister_patch_baseline_for_patch_group(
        &self, 
        input: DeregisterPatchBaselineForPatchGroupRequest
    ) -> RusotoFuture<DeregisterPatchBaselineForPatchGroupResult, DeregisterPatchBaselineForPatchGroupError>;

    fn deregister_target_from_maintenance_window(
        &self, 
        input: DeregisterTargetFromMaintenanceWindowRequest
    ) -> RusotoFuture<DeregisterTargetFromMaintenanceWindowResult, DeregisterTargetFromMaintenanceWindowError>;

    fn deregister_task_from_maintenance_window(
        &self, 
        input: DeregisterTaskFromMaintenanceWindowRequest
    ) -> RusotoFuture<DeregisterTaskFromMaintenanceWindowResult, DeregisterTaskFromMaintenanceWindowError>;

    fn describe_activations(
        &self, 
        input: DescribeActivationsRequest
    ) -> RusotoFuture<DescribeActivationsResult, DescribeActivationsError>;

    fn describe_association(
        &self, 
        input: DescribeAssociationRequest
    ) -> RusotoFuture<DescribeAssociationResult, DescribeAssociationError>;

    fn describe_association_execution_targets(
        &self, 
        input: DescribeAssociationExecutionTargetsRequest
    ) -> RusotoFuture<DescribeAssociationExecutionTargetsResult, DescribeAssociationExecutionTargetsError>;

    fn describe_association_executions(
        &self, 
        input: DescribeAssociationExecutionsRequest
    ) -> RusotoFuture<DescribeAssociationExecutionsResult, DescribeAssociationExecutionsError>;

    fn describe_automation_executions(
        &self, 
        input: DescribeAutomationExecutionsRequest
    ) -> RusotoFuture<DescribeAutomationExecutionsResult, DescribeAutomationExecutionsError>;

    fn describe_automation_step_executions(
        &self, 
        input: DescribeAutomationStepExecutionsRequest
    ) -> RusotoFuture<DescribeAutomationStepExecutionsResult, DescribeAutomationStepExecutionsError>;

    fn describe_available_patches(
        &self, 
        input: DescribeAvailablePatchesRequest
    ) -> RusotoFuture<DescribeAvailablePatchesResult, DescribeAvailablePatchesError>;

    fn describe_document(
        &self, 
        input: DescribeDocumentRequest
    ) -> RusotoFuture<DescribeDocumentResult, DescribeDocumentError>;

    fn describe_document_permission(
        &self, 
        input: DescribeDocumentPermissionRequest
    ) -> RusotoFuture<DescribeDocumentPermissionResponse, DescribeDocumentPermissionError>;

    fn describe_effective_instance_associations(
        &self, 
        input: DescribeEffectiveInstanceAssociationsRequest
    ) -> RusotoFuture<DescribeEffectiveInstanceAssociationsResult, DescribeEffectiveInstanceAssociationsError>;

    fn describe_effective_patches_for_patch_baseline(
        &self, 
        input: DescribeEffectivePatchesForPatchBaselineRequest
    ) -> RusotoFuture<DescribeEffectivePatchesForPatchBaselineResult, DescribeEffectivePatchesForPatchBaselineError>;

    fn describe_instance_associations_status(
        &self, 
        input: DescribeInstanceAssociationsStatusRequest
    ) -> RusotoFuture<DescribeInstanceAssociationsStatusResult, DescribeInstanceAssociationsStatusError>;

    fn describe_instance_information(
        &self, 
        input: DescribeInstanceInformationRequest
    ) -> RusotoFuture<DescribeInstanceInformationResult, DescribeInstanceInformationError>;

    fn describe_instance_patch_states(
        &self, 
        input: DescribeInstancePatchStatesRequest
    ) -> RusotoFuture<DescribeInstancePatchStatesResult, DescribeInstancePatchStatesError>;

    fn describe_instance_patch_states_for_patch_group(
        &self, 
        input: DescribeInstancePatchStatesForPatchGroupRequest
    ) -> RusotoFuture<DescribeInstancePatchStatesForPatchGroupResult, DescribeInstancePatchStatesForPatchGroupError>;

    fn describe_instance_patches(
        &self, 
        input: DescribeInstancePatchesRequest
    ) -> RusotoFuture<DescribeInstancePatchesResult, DescribeInstancePatchesError>;

    fn describe_inventory_deletions(
        &self, 
        input: DescribeInventoryDeletionsRequest
    ) -> RusotoFuture<DescribeInventoryDeletionsResult, DescribeInventoryDeletionsError>;

    fn describe_maintenance_window_execution_task_invocations(
        &self, 
        input: DescribeMaintenanceWindowExecutionTaskInvocationsRequest
    ) -> RusotoFuture<DescribeMaintenanceWindowExecutionTaskInvocationsResult, DescribeMaintenanceWindowExecutionTaskInvocationsError>;

    fn describe_maintenance_window_execution_tasks(
        &self, 
        input: DescribeMaintenanceWindowExecutionTasksRequest
    ) -> RusotoFuture<DescribeMaintenanceWindowExecutionTasksResult, DescribeMaintenanceWindowExecutionTasksError>;

    fn describe_maintenance_window_executions(
        &self, 
        input: DescribeMaintenanceWindowExecutionsRequest
    ) -> RusotoFuture<DescribeMaintenanceWindowExecutionsResult, DescribeMaintenanceWindowExecutionsError>;

    fn describe_maintenance_window_targets(
        &self, 
        input: DescribeMaintenanceWindowTargetsRequest
    ) -> RusotoFuture<DescribeMaintenanceWindowTargetsResult, DescribeMaintenanceWindowTargetsError>;

    fn describe_maintenance_window_tasks(
        &self, 
        input: DescribeMaintenanceWindowTasksRequest
    ) -> RusotoFuture<DescribeMaintenanceWindowTasksResult, DescribeMaintenanceWindowTasksError>;

    fn describe_maintenance_windows(
        &self, 
        input: DescribeMaintenanceWindowsRequest
    ) -> RusotoFuture<DescribeMaintenanceWindowsResult, DescribeMaintenanceWindowsError>;

    fn describe_parameters(
        &self, 
        input: DescribeParametersRequest
    ) -> RusotoFuture<DescribeParametersResult, DescribeParametersError>;

    fn describe_patch_baselines(
        &self, 
        input: DescribePatchBaselinesRequest
    ) -> RusotoFuture<DescribePatchBaselinesResult, DescribePatchBaselinesError>;

    fn describe_patch_group_state(
        &self, 
        input: DescribePatchGroupStateRequest
    ) -> RusotoFuture<DescribePatchGroupStateResult, DescribePatchGroupStateError>;

    fn describe_patch_groups(
        &self, 
        input: DescribePatchGroupsRequest
    ) -> RusotoFuture<DescribePatchGroupsResult, DescribePatchGroupsError>;

    fn get_automation_execution(
        &self, 
        input: GetAutomationExecutionRequest
    ) -> RusotoFuture<GetAutomationExecutionResult, GetAutomationExecutionError>;

    fn get_command_invocation(
        &self, 
        input: GetCommandInvocationRequest
    ) -> RusotoFuture<GetCommandInvocationResult, GetCommandInvocationError>;

    fn get_default_patch_baseline(
        &self, 
        input: GetDefaultPatchBaselineRequest
    ) -> RusotoFuture<GetDefaultPatchBaselineResult, GetDefaultPatchBaselineError>;

    fn get_deployable_patch_snapshot_for_instance(
        &self, 
        input: GetDeployablePatchSnapshotForInstanceRequest
    ) -> RusotoFuture<GetDeployablePatchSnapshotForInstanceResult, GetDeployablePatchSnapshotForInstanceError>;

    fn get_document(
        &self, 
        input: GetDocumentRequest
    ) -> RusotoFuture<GetDocumentResult, GetDocumentError>;

    fn get_inventory(
        &self, 
        input: GetInventoryRequest
    ) -> RusotoFuture<GetInventoryResult, GetInventoryError>;

    fn get_inventory_schema(
        &self, 
        input: GetInventorySchemaRequest
    ) -> RusotoFuture<GetInventorySchemaResult, GetInventorySchemaError>;

    fn get_maintenance_window(
        &self, 
        input: GetMaintenanceWindowRequest
    ) -> RusotoFuture<GetMaintenanceWindowResult, GetMaintenanceWindowError>;

    fn get_maintenance_window_execution(
        &self, 
        input: GetMaintenanceWindowExecutionRequest
    ) -> RusotoFuture<GetMaintenanceWindowExecutionResult, GetMaintenanceWindowExecutionError>;

    fn get_maintenance_window_execution_task(
        &self, 
        input: GetMaintenanceWindowExecutionTaskRequest
    ) -> RusotoFuture<GetMaintenanceWindowExecutionTaskResult, GetMaintenanceWindowExecutionTaskError>;

    fn get_maintenance_window_execution_task_invocation(
        &self, 
        input: GetMaintenanceWindowExecutionTaskInvocationRequest
    ) -> RusotoFuture<GetMaintenanceWindowExecutionTaskInvocationResult, GetMaintenanceWindowExecutionTaskInvocationError>;

    fn get_maintenance_window_task(
        &self, 
        input: GetMaintenanceWindowTaskRequest
    ) -> RusotoFuture<GetMaintenanceWindowTaskResult, GetMaintenanceWindowTaskError>;

    fn get_parameter(
        &self, 
        input: GetParameterRequest
    ) -> RusotoFuture<GetParameterResult, GetParameterError>;

    fn get_parameter_history(
        &self, 
        input: GetParameterHistoryRequest
    ) -> RusotoFuture<GetParameterHistoryResult, GetParameterHistoryError>;

    fn get_parameters(
        &self, 
        input: GetParametersRequest
    ) -> RusotoFuture<GetParametersResult, GetParametersError>;

    fn get_parameters_by_path(
        &self, 
        input: GetParametersByPathRequest
    ) -> RusotoFuture<GetParametersByPathResult, GetParametersByPathError>;

    fn get_patch_baseline(
        &self, 
        input: GetPatchBaselineRequest
    ) -> RusotoFuture<GetPatchBaselineResult, GetPatchBaselineError>;

    fn get_patch_baseline_for_patch_group(
        &self, 
        input: GetPatchBaselineForPatchGroupRequest
    ) -> RusotoFuture<GetPatchBaselineForPatchGroupResult, GetPatchBaselineForPatchGroupError>;

    fn label_parameter_version(
        &self, 
        input: LabelParameterVersionRequest
    ) -> RusotoFuture<LabelParameterVersionResult, LabelParameterVersionError>;

    fn list_association_versions(
        &self, 
        input: ListAssociationVersionsRequest
    ) -> RusotoFuture<ListAssociationVersionsResult, ListAssociationVersionsError>;

    fn list_associations(
        &self, 
        input: ListAssociationsRequest
    ) -> RusotoFuture<ListAssociationsResult, ListAssociationsError>;

    fn list_command_invocations(
        &self, 
        input: ListCommandInvocationsRequest
    ) -> RusotoFuture<ListCommandInvocationsResult, ListCommandInvocationsError>;

    fn list_commands(
        &self, 
        input: ListCommandsRequest
    ) -> RusotoFuture<ListCommandsResult, ListCommandsError>;

    fn list_compliance_items(
        &self, 
        input: ListComplianceItemsRequest
    ) -> RusotoFuture<ListComplianceItemsResult, ListComplianceItemsError>;

    fn list_compliance_summaries(
        &self, 
        input: ListComplianceSummariesRequest
    ) -> RusotoFuture<ListComplianceSummariesResult, ListComplianceSummariesError>;

    fn list_document_versions(
        &self, 
        input: ListDocumentVersionsRequest
    ) -> RusotoFuture<ListDocumentVersionsResult, ListDocumentVersionsError>;

    fn list_documents(
        &self, 
        input: ListDocumentsRequest
    ) -> RusotoFuture<ListDocumentsResult, ListDocumentsError>;

    fn list_inventory_entries(
        &self, 
        input: ListInventoryEntriesRequest
    ) -> RusotoFuture<ListInventoryEntriesResult, ListInventoryEntriesError>;

    fn list_resource_compliance_summaries(
        &self, 
        input: ListResourceComplianceSummariesRequest
    ) -> RusotoFuture<ListResourceComplianceSummariesResult, ListResourceComplianceSummariesError>;

    fn list_resource_data_sync(
        &self, 
        input: ListResourceDataSyncRequest
    ) -> RusotoFuture<ListResourceDataSyncResult, ListResourceDataSyncError>;

    fn list_tags_for_resource(
        &self, 
        input: ListTagsForResourceRequest
    ) -> RusotoFuture<ListTagsForResourceResult, ListTagsForResourceError>;

    fn modify_document_permission(
        &self, 
        input: ModifyDocumentPermissionRequest
    ) -> RusotoFuture<ModifyDocumentPermissionResponse, ModifyDocumentPermissionError>;

    fn put_compliance_items(
        &self, 
        input: PutComplianceItemsRequest
    ) -> RusotoFuture<PutComplianceItemsResult, PutComplianceItemsError>;

    fn put_inventory(
        &self, 
        input: PutInventoryRequest
    ) -> RusotoFuture<PutInventoryResult, PutInventoryError>;

    fn put_parameter(
        &self, 
        input: PutParameterRequest
    ) -> RusotoFuture<PutParameterResult, PutParameterError>;

    fn register_default_patch_baseline(
        &self, 
        input: RegisterDefaultPatchBaselineRequest
    ) -> RusotoFuture<RegisterDefaultPatchBaselineResult, RegisterDefaultPatchBaselineError>;

    fn register_patch_baseline_for_patch_group(
        &self, 
        input: RegisterPatchBaselineForPatchGroupRequest
    ) -> RusotoFuture<RegisterPatchBaselineForPatchGroupResult, RegisterPatchBaselineForPatchGroupError>;

    fn register_target_with_maintenance_window(
        &self, 
        input: RegisterTargetWithMaintenanceWindowRequest
    ) -> RusotoFuture<RegisterTargetWithMaintenanceWindowResult, RegisterTargetWithMaintenanceWindowError>;

    fn register_task_with_maintenance_window(
        &self, 
        input: RegisterTaskWithMaintenanceWindowRequest
    ) -> RusotoFuture<RegisterTaskWithMaintenanceWindowResult, RegisterTaskWithMaintenanceWindowError>;

    fn remove_tags_from_resource(
        &self, 
        input: RemoveTagsFromResourceRequest
    ) -> RusotoFuture<RemoveTagsFromResourceResult, RemoveTagsFromResourceError>;

    fn send_automation_signal(
        &self, 
        input: SendAutomationSignalRequest
    ) -> RusotoFuture<SendAutomationSignalResult, SendAutomationSignalError>;

    fn send_command(
        &self, 
        input: SendCommandRequest
    ) -> RusotoFuture<SendCommandResult, SendCommandError>;

    fn start_associations_once(
        &self, 
        input: StartAssociationsOnceRequest
    ) -> RusotoFuture<StartAssociationsOnceResult, StartAssociationsOnceError>;

    fn start_automation_execution(
        &self, 
        input: StartAutomationExecutionRequest
    ) -> RusotoFuture<StartAutomationExecutionResult, StartAutomationExecutionError>;

    fn stop_automation_execution(
        &self, 
        input: StopAutomationExecutionRequest
    ) -> RusotoFuture<StopAutomationExecutionResult, StopAutomationExecutionError>;

    fn update_association(
        &self, 
        input: UpdateAssociationRequest
    ) -> RusotoFuture<UpdateAssociationResult, UpdateAssociationError>;

    fn update_association_status(
        &self, 
        input: UpdateAssociationStatusRequest
    ) -> RusotoFuture<UpdateAssociationStatusResult, UpdateAssociationStatusError>;

    fn update_document(
        &self, 
        input: UpdateDocumentRequest
    ) -> RusotoFuture<UpdateDocumentResult, UpdateDocumentError>;

    fn update_document_default_version(
        &self, 
        input: UpdateDocumentDefaultVersionRequest
    ) -> RusotoFuture<UpdateDocumentDefaultVersionResult, UpdateDocumentDefaultVersionError>;

    fn update_maintenance_window(
        &self, 
        input: UpdateMaintenanceWindowRequest
    ) -> RusotoFuture<UpdateMaintenanceWindowResult, UpdateMaintenanceWindowError>;

    fn update_maintenance_window_target(
        &self, 
        input: UpdateMaintenanceWindowTargetRequest
    ) -> RusotoFuture<UpdateMaintenanceWindowTargetResult, UpdateMaintenanceWindowTargetError>;

    fn update_maintenance_window_task(
        &self, 
        input: UpdateMaintenanceWindowTaskRequest
    ) -> RusotoFuture<UpdateMaintenanceWindowTaskResult, UpdateMaintenanceWindowTaskError>;

    fn update_managed_instance_role(
        &self, 
        input: UpdateManagedInstanceRoleRequest
    ) -> RusotoFuture<UpdateManagedInstanceRoleResult, UpdateManagedInstanceRoleError>;

    fn update_patch_baseline(
        &self, 
        input: UpdatePatchBaselineRequest
    ) -> RusotoFuture<UpdatePatchBaselineResult, UpdatePatchBaselineError>;
}

Trait representing the capabilities of the Amazon SSM API. Amazon SSM clients implement this trait.

Required Methods

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.

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.

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.

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.

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.

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.

Creates a Systems Manager document.

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

Creates a new Maintenance Window.

Creates a patch baseline.

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

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.

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 Create a Resource Data Sync for Inventory in the AWS Systems Manager User Guide.

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.

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.

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.

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

Deletes a Maintenance Window.

Delete a parameter from the system.

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

Deletes a patch baseline.

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.

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 SSM Agent first.

Removes a patch group from a patch baseline.

Removes a target from a Maintenance Window.

Removes a task from a Maintenance Window.

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.

Describes the association for the specified target or instance. If you created the association by using the Targets 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.

Use this API action to view information about a specific execution of a specific association.

Use this API action to view all executions for a specific association ID.

Provides details about all active and terminated Automation executions.

Information about all active and terminated step executions in an Automation workflow.

Lists all patches that could possibly be included in a patch baseline.

Describes the specified Systems Manager document.

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

All associations for the instance(s).

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.

The status of the associations for the instance(s).

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.

The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.

Retrieves the high-level patch state of one or more instances.

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

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

Describes a specific delete inventory operation.

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

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

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.

Lists the targets registered with the Maintenance Window.

Lists the tasks in a Maintenance Window.

Retrieves the Maintenance Windows in an AWS account.

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.

Lists the patch baselines in your AWS account.

Returns high-level aggregated patch compliance state for a patch group.

Lists all patch groups that have been registered with patch baselines.

Get detailed information about a particular Automation execution.

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

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

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

Gets the contents of the specified Systems Manager document.

Query inventory information.

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

Retrieves a Maintenance Window.

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

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

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

Lists the tasks in a Maintenance Window.

Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.

Query a list of all parameters used by the AWS account.

Get details of a parameter. Don't confuse this API action with the GetParameter API action.

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide.

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.

This API action doesn't support filtering by tags.

Retrieves information about a patch baseline.

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

Retrieves all versions of an association for a specific association ID.

Lists the associations for the specified Systems Manager document or instance.

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.

Lists the commands requested by users of the AWS account.

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.

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.

List all versions for a document.

Describes one or more of your Systems Manager documents.

A list of inventory items returned by the request.

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.

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.

Returns a list of the tags assigned to the specified resource.

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.

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:

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

  • ExecutionType: Specify patch, association, or Custom:string.

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

  • Id: The patch, association, or custom compliance ID.

  • Title: A title.

  • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

  • Severity: A patch severity. For example, critical.

  • DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.

  • DocumentVersion: An SSM document version number. For example, 4.

  • Classification: A patch classification. For example, security updates.

  • PatchBaselineId: A patch baseline ID.

  • PatchSeverity: A patch severity. For example, Critical.

  • PatchState: A patch state. For example, InstancesWithFailedPatches.

  • PatchGroup: The name of a patch group.

  • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

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.

Add a parameter to the system.

Defines the default patch baseline.

Registers a patch baseline for a patch group.

Registers a target with a Maintenance Window.

Adds a new task to a Maintenance Window.

Removes all tags from the specified resource.

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

Executes commands on one or more managed instances.

Use this API action to execute an association immediately and only one time. This action can be helpful when troubleshooting associations.

Initiates execution of an Automation document.

Stop an Automation that is currently executing.

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

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

The document you want to update.

Set the default version of a document.

Updates an existing Maintenance Window. Only specified parameters are modified.

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.

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

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

  • ServiceRoleArn

  • TaskInvocationParameters

  • Priority

  • MaxConcurrency

  • MaxErrors

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.

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

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

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

Implementors

impl Ssm for SsmClient
[src]

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.

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.

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.

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.

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.

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.

Creates a Systems Manager document.

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

Creates a new Maintenance Window.

Creates a patch baseline.

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

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.

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 Create a Resource Data Sync for Inventory in the AWS Systems Manager User Guide.

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.

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.

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.

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

Deletes a Maintenance Window.

Delete a parameter from the system.

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

Deletes a patch baseline.

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.

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 SSM Agent first.

Removes a patch group from a patch baseline.

Removes a target from a Maintenance Window.

Removes a task from a Maintenance Window.

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.

Describes the association for the specified target or instance. If you created the association by using the Targets 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.

Use this API action to view information about a specific execution of a specific association.

Use this API action to view all executions for a specific association ID.

Provides details about all active and terminated Automation executions.

Information about all active and terminated step executions in an Automation workflow.

Lists all patches that could possibly be included in a patch baseline.

Describes the specified Systems Manager document.

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

All associations for the instance(s).

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.

The status of the associations for the instance(s).

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.

The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.

Retrieves the high-level patch state of one or more instances.

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

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

Describes a specific delete inventory operation.

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

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

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.

Lists the targets registered with the Maintenance Window.

Lists the tasks in a Maintenance Window.

Retrieves the Maintenance Windows in an AWS account.

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.

Lists the patch baselines in your AWS account.

Returns high-level aggregated patch compliance state for a patch group.

Lists all patch groups that have been registered with patch baselines.

Get detailed information about a particular Automation execution.

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

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

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

Gets the contents of the specified Systems Manager document.

Query inventory information.

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

Retrieves a Maintenance Window.

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

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

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

Lists the tasks in a Maintenance Window.

Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.

Query a list of all parameters used by the AWS account.

Get details of a parameter. Don't confuse this API action with the GetParameter API action.

Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide.

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.

This API action doesn't support filtering by tags.

Retrieves information about a patch baseline.

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

Retrieves all versions of an association for a specific association ID.

Lists the associations for the specified Systems Manager document or instance.

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.

Lists the commands requested by users of the AWS account.

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.

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.

List all versions for a document.

Describes one or more of your Systems Manager documents.

A list of inventory items returned by the request.

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.

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.

Returns a list of the tags assigned to the specified resource.

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.

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:

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

  • ExecutionType: Specify patch, association, or Custom:string.

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

  • Id: The patch, association, or custom compliance ID.

  • Title: A title.

  • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

  • Severity: A patch severity. For example, critical.

  • DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.

  • DocumentVersion: An SSM document version number. For example, 4.

  • Classification: A patch classification. For example, security updates.

  • PatchBaselineId: A patch baseline ID.

  • PatchSeverity: A patch severity. For example, Critical.

  • PatchState: A patch state. For example, InstancesWithFailedPatches.

  • PatchGroup: The name of a patch group.

  • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

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.

Add a parameter to the system.

Defines the default patch baseline.

Registers a patch baseline for a patch group.

Registers a target with a Maintenance Window.

Adds a new task to a Maintenance Window.

Removes all tags from the specified resource.

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

Executes commands on one or more managed instances.

Use this API action to execute an association immediately and only one time. This action can be helpful when troubleshooting associations.

Initiates execution of an Automation document.

Stop an Automation that is currently executing.

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

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

The document you want to update.

Set the default version of a document.

Updates an existing Maintenance Window. Only specified parameters are modified.

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.

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

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

  • ServiceRoleArn

  • TaskInvocationParameters

  • Priority

  • MaxConcurrency

  • MaxErrors

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.

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

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

For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.