Class: Aws::SSM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SSM::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-ssm/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#add_tags_to_resource(params = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified resource.
-
#cancel_command(params = {}) ⇒ Struct
Attempts to cancel the command specified by the Command ID.
-
#cancel_maintenance_window_execution(params = {}) ⇒ Types::CancelMaintenanceWindowExecutionResult
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running.
-
#create_activation(params = {}) ⇒ Types::CreateActivationResult
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command.
-
#create_association(params = {}) ⇒ Types::CreateAssociationResult
Associates the specified Systems Manager document with the specified instances or targets.
-
#create_association_batch(params = {}) ⇒ Types::CreateAssociationBatchResult
Associates the specified Systems Manager document with the specified instances or targets.
-
#create_document(params = {}) ⇒ Types::CreateDocumentResult
Creates a Systems Manager document.
-
#create_maintenance_window(params = {}) ⇒ Types::CreateMaintenanceWindowResult
Creates a new maintenance window.
-
#create_ops_item(params = {}) ⇒ Types::CreateOpsItemResponse
Creates a new OpsItem.
-
#create_patch_baseline(params = {}) ⇒ Types::CreatePatchBaselineResult
Creates a patch baseline.
-
#create_resource_data_sync(params = {}) ⇒ Struct
A resource data sync helps you view data from multiple sources in a single location.
-
#delete_activation(params = {}) ⇒ Struct
Deletes an activation.
-
#delete_association(params = {}) ⇒ Struct
Disassociates the specified Systems Manager document from the specified instance.
-
#delete_document(params = {}) ⇒ Struct
Deletes the Systems Manager document and all instance associations to the document.
-
#delete_inventory(params = {}) ⇒ Types::DeleteInventoryResult
Delete a custom inventory type, or the data associated with a custom Inventory type.
-
#delete_maintenance_window(params = {}) ⇒ Types::DeleteMaintenanceWindowResult
Deletes a maintenance window.
-
#delete_parameter(params = {}) ⇒ Struct
Delete a parameter from the system.
-
#delete_parameters(params = {}) ⇒ Types::DeleteParametersResult
Delete a list of parameters.
-
#delete_patch_baseline(params = {}) ⇒ Types::DeletePatchBaselineResult
Deletes a patch baseline.
-
#delete_resource_data_sync(params = {}) ⇒ Struct
Deletes a Resource Data Sync configuration.
-
#deregister_managed_instance(params = {}) ⇒ Struct
Removes the server or virtual machine from the list of registered servers.
-
#deregister_patch_baseline_for_patch_group(params = {}) ⇒ Types::DeregisterPatchBaselineForPatchGroupResult
Removes a patch group from a patch baseline.
-
#deregister_target_from_maintenance_window(params = {}) ⇒ Types::DeregisterTargetFromMaintenanceWindowResult
Removes a target from a maintenance window.
-
#deregister_task_from_maintenance_window(params = {}) ⇒ Types::DeregisterTaskFromMaintenanceWindowResult
Removes a task from a maintenance window.
-
#describe_activations(params = {}) ⇒ Types::DescribeActivationsResult
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
-
#describe_association(params = {}) ⇒ Types::DescribeAssociationResult
Describes the association for the specified target or instance.
-
#describe_association_execution_targets(params = {}) ⇒ Types::DescribeAssociationExecutionTargetsResult
Use this API action to view information about a specific execution of a specific association.
-
#describe_association_executions(params = {}) ⇒ Types::DescribeAssociationExecutionsResult
Use this API action to view all executions for a specific association ID.
-
#describe_automation_executions(params = {}) ⇒ Types::DescribeAutomationExecutionsResult
Provides details about all active and terminated Automation executions.
-
#describe_automation_step_executions(params = {}) ⇒ Types::DescribeAutomationStepExecutionsResult
Information about all active and terminated step executions in an Automation workflow.
-
#describe_available_patches(params = {}) ⇒ Types::DescribeAvailablePatchesResult
Lists all patches eligible to be included in a patch baseline.
-
#describe_document(params = {}) ⇒ Types::DescribeDocumentResult
Describes the specified Systems Manager document.
-
#describe_document_permission(params = {}) ⇒ Types::DescribeDocumentPermissionResponse
Describes the permissions for a Systems Manager document.
-
#describe_effective_instance_associations(params = {}) ⇒ Types::DescribeEffectiveInstanceAssociationsResult
All associations for the instance(s).
-
#describe_effective_patches_for_patch_baseline(params = {}) ⇒ Types::DescribeEffectivePatchesForPatchBaselineResult
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
-
#describe_instance_associations_status(params = {}) ⇒ Types::DescribeInstanceAssociationsStatusResult
The status of the associations for the instance(s).
-
#describe_instance_information(params = {}) ⇒ Types::DescribeInstanceInformationResult
Describes one or more of your instances.
-
#describe_instance_patch_states(params = {}) ⇒ Types::DescribeInstancePatchStatesResult
Retrieves the high-level patch state of one or more instances.
-
#describe_instance_patch_states_for_patch_group(params = {}) ⇒ Types::DescribeInstancePatchStatesForPatchGroupResult
Retrieves the high-level patch state for the instances in the specified patch group.
-
#describe_instance_patches(params = {}) ⇒ Types::DescribeInstancePatchesResult
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
-
#describe_inventory_deletions(params = {}) ⇒ Types::DescribeInventoryDeletionsResult
Describes a specific delete inventory operation.
-
#describe_maintenance_window_execution_task_invocations(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionTaskInvocationsResult
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
-
#describe_maintenance_window_execution_tasks(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionTasksResult
For a given maintenance window execution, lists the tasks that were run.
-
#describe_maintenance_window_executions(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionsResult
Lists the executions of a maintenance window.
-
#describe_maintenance_window_schedule(params = {}) ⇒ Types::DescribeMaintenanceWindowScheduleResult
Retrieves information about upcoming executions of a maintenance window.
-
#describe_maintenance_window_targets(params = {}) ⇒ Types::DescribeMaintenanceWindowTargetsResult
Lists the targets registered with the maintenance window.
-
#describe_maintenance_window_tasks(params = {}) ⇒ Types::DescribeMaintenanceWindowTasksResult
Lists the tasks in a maintenance window.
-
#describe_maintenance_windows(params = {}) ⇒ Types::DescribeMaintenanceWindowsResult
Retrieves the maintenance windows in an AWS account.
-
#describe_maintenance_windows_for_target(params = {}) ⇒ Types::DescribeMaintenanceWindowsForTargetResult
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
-
#describe_ops_items(params = {}) ⇒ Types::DescribeOpsItemsResponse
Query a set of OpsItems.
-
#describe_parameters(params = {}) ⇒ Types::DescribeParametersResult
Get information about a parameter.
-
#describe_patch_baselines(params = {}) ⇒ Types::DescribePatchBaselinesResult
Lists the patch baselines in your AWS account.
-
#describe_patch_group_state(params = {}) ⇒ Types::DescribePatchGroupStateResult
Returns high-level aggregated patch compliance state for a patch group.
-
#describe_patch_groups(params = {}) ⇒ Types::DescribePatchGroupsResult
Lists all patch groups that have been registered with patch baselines.
-
#describe_patch_properties(params = {}) ⇒ Types::DescribePatchPropertiesResult
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches.
-
#describe_sessions(params = {}) ⇒ Types::DescribeSessionsResponse
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
-
#get_automation_execution(params = {}) ⇒ Types::GetAutomationExecutionResult
Get detailed information about a particular Automation execution.
-
#get_command_invocation(params = {}) ⇒ Types::GetCommandInvocationResult
Returns detailed information about command execution for an invocation or plugin.
-
#get_connection_status(params = {}) ⇒ Types::GetConnectionStatusResponse
Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
-
#get_default_patch_baseline(params = {}) ⇒ Types::GetDefaultPatchBaselineResult
Retrieves the default patch baseline.
-
#get_deployable_patch_snapshot_for_instance(params = {}) ⇒ Types::GetDeployablePatchSnapshotForInstanceResult
Retrieves the current snapshot for the patch baseline the instance uses.
-
#get_document(params = {}) ⇒ Types::GetDocumentResult
Gets the contents of the specified Systems Manager document.
-
#get_inventory(params = {}) ⇒ Types::GetInventoryResult
Query inventory information.
-
#get_inventory_schema(params = {}) ⇒ Types::GetInventorySchemaResult
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
-
#get_maintenance_window(params = {}) ⇒ Types::GetMaintenanceWindowResult
Retrieves a maintenance window.
-
#get_maintenance_window_execution(params = {}) ⇒ Types::GetMaintenanceWindowExecutionResult
Retrieves details about a specific a maintenance window execution.
-
#get_maintenance_window_execution_task(params = {}) ⇒ Types::GetMaintenanceWindowExecutionTaskResult
Retrieves the details about a specific task run as part of a maintenance window execution.
-
#get_maintenance_window_execution_task_invocation(params = {}) ⇒ Types::GetMaintenanceWindowExecutionTaskInvocationResult
Retrieves information about a specific task running on a specific target.
-
#get_maintenance_window_task(params = {}) ⇒ Types::GetMaintenanceWindowTaskResult
Lists the tasks in a maintenance window.
-
#get_ops_item(params = {}) ⇒ Types::GetOpsItemResponse
Get information about an OpsItem by using the ID.
-
#get_ops_summary(params = {}) ⇒ Types::GetOpsSummaryResult
View a summary of OpsItems based on specified filters and aggregators.
-
#get_parameter(params = {}) ⇒ Types::GetParameterResult
Get information about a parameter by using the parameter name.
-
#get_parameter_history(params = {}) ⇒ Types::GetParameterHistoryResult
Query a list of all parameters used by the AWS account.
-
#get_parameters(params = {}) ⇒ Types::GetParametersResult
Get details of a parameter.
-
#get_parameters_by_path(params = {}) ⇒ Types::GetParametersByPathResult
Retrieve information about one or more parameters in a specific hierarchy.
-
#get_patch_baseline(params = {}) ⇒ Types::GetPatchBaselineResult
Retrieves information about a patch baseline.
-
#get_patch_baseline_for_patch_group(params = {}) ⇒ Types::GetPatchBaselineForPatchGroupResult
Retrieves the patch baseline that should be used for the specified patch group.
-
#get_service_setting(params = {}) ⇒ Types::GetServiceSettingResult
‘ServiceSetting` is an account-level setting for an AWS service.
-
#label_parameter_version(params = {}) ⇒ Types::LabelParameterVersionResult
A parameter label is a user-defined alias to help you manage different versions of a parameter.
-
#list_association_versions(params = {}) ⇒ Types::ListAssociationVersionsResult
Retrieves all versions of an association for a specific association ID.
-
#list_associations(params = {}) ⇒ Types::ListAssociationsResult
Lists the associations for the specified Systems Manager document or instance.
-
#list_command_invocations(params = {}) ⇒ Types::ListCommandInvocationsResult
An invocation is copy of a command sent to a specific instance.
-
#list_commands(params = {}) ⇒ Types::ListCommandsResult
Lists the commands requested by users of the AWS account.
-
#list_compliance_items(params = {}) ⇒ Types::ListComplianceItemsResult
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
-
#list_compliance_summaries(params = {}) ⇒ Types::ListComplianceSummariesResult
Returns a summary count of compliant and non-compliant resources for a compliance type.
-
#list_document_versions(params = {}) ⇒ Types::ListDocumentVersionsResult
List all versions for a document.
-
#list_documents(params = {}) ⇒ Types::ListDocumentsResult
Describes one or more of your Systems Manager documents.
-
#list_inventory_entries(params = {}) ⇒ Types::ListInventoryEntriesResult
A list of inventory items returned by the request.
-
#list_resource_compliance_summaries(params = {}) ⇒ Types::ListResourceComplianceSummariesResult
Returns a resource-level summary count.
-
#list_resource_data_sync(params = {}) ⇒ Types::ListResourceDataSyncResult
Lists your resource data sync configurations.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Returns a list of the tags assigned to the specified resource.
-
#modify_document_permission(params = {}) ⇒ Struct
Shares a Systems Manager document publicly or privately.
-
#put_compliance_items(params = {}) ⇒ Struct
Registers a compliance type and other compliance details on a designated resource.
-
#put_inventory(params = {}) ⇒ Types::PutInventoryResult
Bulk update custom inventory items on one more instance.
-
#put_parameter(params = {}) ⇒ Types::PutParameterResult
Add a parameter to the system.
-
#register_default_patch_baseline(params = {}) ⇒ Types::RegisterDefaultPatchBaselineResult
Defines the default patch baseline for the relevant operating system.
-
#register_patch_baseline_for_patch_group(params = {}) ⇒ Types::RegisterPatchBaselineForPatchGroupResult
Registers a patch baseline for a patch group.
-
#register_target_with_maintenance_window(params = {}) ⇒ Types::RegisterTargetWithMaintenanceWindowResult
Registers a target with a maintenance window.
-
#register_task_with_maintenance_window(params = {}) ⇒ Types::RegisterTaskWithMaintenanceWindowResult
Adds a new task to a maintenance window.
-
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes tag keys from the specified resource.
-
#reset_service_setting(params = {}) ⇒ Types::ResetServiceSettingResult
‘ServiceSetting` is an account-level setting for an AWS service.
-
#resume_session(params = {}) ⇒ Types::ResumeSessionResponse
Reconnects a session to an instance after it has been disconnected.
-
#send_automation_signal(params = {}) ⇒ Struct
Sends a signal to an Automation execution to change the current behavior or status of the execution.
-
#send_command(params = {}) ⇒ Types::SendCommandResult
Runs commands on one or more managed instances.
-
#start_associations_once(params = {}) ⇒ Struct
Use this API action to run an association immediately and only one time.
-
#start_automation_execution(params = {}) ⇒ Types::StartAutomationExecutionResult
Initiates execution of an Automation document.
-
#start_session(params = {}) ⇒ Types::StartSessionResponse
Initiates a connection to a target (for example, an instance) for a Session Manager session.
-
#stop_automation_execution(params = {}) ⇒ Struct
Stop an Automation that is currently running.
-
#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance.
-
#update_association(params = {}) ⇒ Types::UpdateAssociationResult
Updates an association.
-
#update_association_status(params = {}) ⇒ Types::UpdateAssociationStatusResult
Updates the status of the Systems Manager document associated with the specified instance.
-
#update_document(params = {}) ⇒ Types::UpdateDocumentResult
Updates one or more values for an SSM document.
-
#update_document_default_version(params = {}) ⇒ Types::UpdateDocumentDefaultVersionResult
Set the default version of a document.
-
#update_maintenance_window(params = {}) ⇒ Types::UpdateMaintenanceWindowResult
Updates an existing maintenance window.
-
#update_maintenance_window_target(params = {}) ⇒ Types::UpdateMaintenanceWindowTargetResult
Modifies the target of an existing maintenance window.
-
#update_maintenance_window_task(params = {}) ⇒ Types::UpdateMaintenanceWindowTaskResult
Modifies a task assigned to a maintenance window.
-
#update_managed_instance_role(params = {}) ⇒ Struct
Assigns or changes an Amazon Identity and Access Management (IAM) role for the managed instance.
-
#update_ops_item(params = {}) ⇒ Struct
Edit or change an OpsItem.
-
#update_patch_baseline(params = {}) ⇒ Types::UpdatePatchBaselineResult
Modifies an existing patch baseline.
-
#update_resource_data_sync(params = {}) ⇒ Struct
Update a resource data sync.
-
#update_service_setting(params = {}) ⇒ Struct
‘ServiceSetting` is an account-level setting for an AWS service.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
261 262 263 |
# File 'lib/aws-sdk-ssm/client.rb', line 261 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9156 9157 9158 |
# File 'lib/aws-sdk-ssm/client.rb', line 9156 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9159 9160 9161 |
# File 'lib/aws-sdk-ssm/client.rb', line 9159 def errors_module Errors end |
Instance Method Details
#add_tags_to_resource(params = {}) ⇒ Struct
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*.
[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html
348 349 350 351 |
# File 'lib/aws-sdk-ssm/client.rb', line 348 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 |
# File 'lib/aws-sdk-ssm/client.rb', line 9134 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ssm' context[:gem_version] = '1.65.0' Seahorse::Client::Request.new(handlers, context) end |
#cancel_command(params = {}) ⇒ Struct
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.
378 379 380 381 |
# File 'lib/aws-sdk-ssm/client.rb', line 378 def cancel_command(params = {}, = {}) req = build_request(:cancel_command, params) req.send_request() end |
#cancel_maintenance_window_execution(params = {}) ⇒ Types::CancelMaintenanceWindowExecutionResult
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
408 409 410 411 |
# File 'lib/aws-sdk-ssm/client.rb', line 408 def cancel_maintenance_window_execution(params = {}, = {}) req = build_request(:cancel_maintenance_window_execution, params) req.send_request() end |
#create_activation(params = {}) ⇒ Types::CreateActivationResult
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 AWS Systems Manager for Hybrid Environments].
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html
505 506 507 508 |
# File 'lib/aws-sdk-ssm/client.rb', line 505 def create_activation(params = {}, = {}) req = build_request(:create_activation, params) req.send_request() end |
#create_association(params = {}) ⇒ Types::CreateAssociationResult
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, 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 returns the AssociationAlreadyExists exception.
689 690 691 692 |
# File 'lib/aws-sdk-ssm/client.rb', line 689 def create_association(params = {}, = {}) req = build_request(:create_association, params) req.send_request() end |
#create_association_batch(params = {}) ⇒ Types::CreateAssociationBatchResult
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, 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 returns the AssociationAlreadyExists exception.
810 811 812 813 |
# File 'lib/aws-sdk-ssm/client.rb', line 810 def create_association_batch(params = {}, = {}) req = build_request(:create_association_batch, params) req.send_request() end |
#create_document(params = {}) ⇒ Types::CreateDocumentResult
Creates a Systems Manager document.
After you create a document, you can use CreateAssociation to associate it with one or more running instances.
960 961 962 963 |
# File 'lib/aws-sdk-ssm/client.rb', line 960 def create_document(params = {}, = {}) req = build_request(:create_document, params) req.send_request() end |
#create_maintenance_window(params = {}) ⇒ Types::CreateMaintenanceWindowResult
Creates a new maintenance window.
<note markdown=“1”> The value you specify for ‘Duration` determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for `Cutoff`. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for `Cutoff` is one hour, no maintenance window tasks can start after 5 PM.
</note>
1085 1086 1087 1088 |
# File 'lib/aws-sdk-ssm/client.rb', line 1085 def create_maintenance_window(params = {}, = {}) req = build_request(:create_maintenance_window, params) req.send_request() end |
#create_ops_item(params = {}) ⇒ Types::CreateOpsItemResponse
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see [Getting Started with OpsCenter] in the *AWS Systems Manager User Guide*.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter] in the *AWS Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
1227 1228 1229 1230 |
# File 'lib/aws-sdk-ssm/client.rb', line 1227 def create_ops_item(params = {}, = {}) req = build_request(:create_ops_item, params) req.send_request() end |
#create_patch_baseline(params = {}) ⇒ Types::CreatePatchBaselineResult
Creates a patch baseline.
<note markdown=“1”> For information about valid key and value pairs in ‘PatchFilters` for each supported operating system type, see [PatchFilter].
</note>
[1]: docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
1399 1400 1401 1402 |
# File 'lib/aws-sdk-ssm/client.rb', line 1399 def create_patch_baseline(params = {}, = {}) req = build_request(:create_patch_baseline, params) req.send_request() end |
#create_resource_data_sync(params = {}) ⇒ Struct
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: ‘SyncToDestination` and `SyncFromSource`.
You can configure Systems Manager Inventory to use the ‘SyncToDestination` type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket. For more information, see
- Configuring Resource Data Sync for Inventory][1
-
in the *AWS Systems
Manager User Guide*.
You can configure Systems Manager Explorer to use the ‘SyncToDestination` type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. You can also configure Explorer to use the `SyncFromSource` type. This type synchronizes OpsItems and OpsData from multiple AWS accounts and Regions by using AWS Organizations. For more information, see [Setting Up Explorer to Display Data from Multiple Accounts and Regions] in the *AWS Systems Manager User Guide*.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
<note markdown=“1”> 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.
</note>
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-datasync.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html
1489 1490 1491 1492 |
# File 'lib/aws-sdk-ssm/client.rb', line 1489 def create_resource_data_sync(params = {}, = {}) req = build_request(:create_resource_data_sync, params) req.send_request() end |
#delete_activation(params = {}) ⇒ Struct
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.
1515 1516 1517 1518 |
# File 'lib/aws-sdk-ssm/client.rb', line 1515 def delete_activation(params = {}, = {}) req = build_request(:delete_activation, params) req.send_request() end |
#delete_association(params = {}) ⇒ Struct
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.
1552 1553 1554 1555 |
# File 'lib/aws-sdk-ssm/client.rb', line 1552 def delete_association(params = {}, = {}) req = build_request(:delete_association, params) req.send_request() end |
#delete_document(params = {}) ⇒ Struct
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.
1597 1598 1599 1600 |
# File 'lib/aws-sdk-ssm/client.rb', line 1597 def delete_document(params = {}, = {}) req = build_request(:delete_document, params) req.send_request() end |
#delete_inventory(params = {}) ⇒ Types::DeleteInventoryResult
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.
1667 1668 1669 1670 |
# File 'lib/aws-sdk-ssm/client.rb', line 1667 def delete_inventory(params = {}, = {}) req = build_request(:delete_inventory, params) req.send_request() end |
#delete_maintenance_window(params = {}) ⇒ Types::DeleteMaintenanceWindowResult
Deletes a maintenance window.
1695 1696 1697 1698 |
# File 'lib/aws-sdk-ssm/client.rb', line 1695 def delete_maintenance_window(params = {}, = {}) req = build_request(:delete_maintenance_window, params) req.send_request() end |
#delete_parameter(params = {}) ⇒ Struct
Delete a parameter from the system.
1717 1718 1719 1720 |
# File 'lib/aws-sdk-ssm/client.rb', line 1717 def delete_parameter(params = {}, = {}) req = build_request(:delete_parameter, params) req.send_request() end |
#delete_parameters(params = {}) ⇒ Types::DeleteParametersResult
Delete a list of parameters.
1749 1750 1751 1752 |
# File 'lib/aws-sdk-ssm/client.rb', line 1749 def delete_parameters(params = {}, = {}) req = build_request(:delete_parameters, params) req.send_request() end |
#delete_patch_baseline(params = {}) ⇒ Types::DeletePatchBaselineResult
Deletes a patch baseline.
1777 1778 1779 1780 |
# File 'lib/aws-sdk-ssm/client.rb', line 1777 def delete_patch_baseline(params = {}, = {}) req = build_request(:delete_patch_baseline, params) req.send_request() end |
#delete_resource_data_sync(params = {}) ⇒ Struct
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
1806 1807 1808 1809 |
# File 'lib/aws-sdk-ssm/client.rb', line 1806 def delete_resource_data_sync(params = {}, = {}) req = build_request(:delete_resource_data_sync, params) req.send_request() end |
#deregister_managed_instance(params = {}) ⇒ Struct
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.
1832 1833 1834 1835 |
# File 'lib/aws-sdk-ssm/client.rb', line 1832 def deregister_managed_instance(params = {}, = {}) req = build_request(:deregister_managed_instance, params) req.send_request() end |
#deregister_patch_baseline_for_patch_group(params = {}) ⇒ Types::DeregisterPatchBaselineForPatchGroupResult
Removes a patch group from a patch baseline.
1867 1868 1869 1870 |
# File 'lib/aws-sdk-ssm/client.rb', line 1867 def deregister_patch_baseline_for_patch_group(params = {}, = {}) req = build_request(:deregister_patch_baseline_for_patch_group, params) req.send_request() end |
#deregister_target_from_maintenance_window(params = {}) ⇒ Types::DeregisterTargetFromMaintenanceWindowResult
Removes a target from a maintenance window.
1907 1908 1909 1910 |
# File 'lib/aws-sdk-ssm/client.rb', line 1907 def deregister_target_from_maintenance_window(params = {}, = {}) req = build_request(:deregister_target_from_maintenance_window, params) req.send_request() end |
#deregister_task_from_maintenance_window(params = {}) ⇒ Types::DeregisterTaskFromMaintenanceWindowResult
Removes a task from a maintenance window.
1941 1942 1943 1944 |
# File 'lib/aws-sdk-ssm/client.rb', line 1941 def deregister_task_from_maintenance_window(params = {}, = {}) req = build_request(:deregister_task_from_maintenance_window, params) req.send_request() end |
#describe_activations(params = {}) ⇒ Types::DescribeActivationsResult
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
2002 2003 2004 2005 |
# File 'lib/aws-sdk-ssm/client.rb', line 2002 def describe_activations(params = {}, = {}) req = build_request(:describe_activations, params) req.send_request() end |
#describe_association(params = {}) ⇒ Types::DescribeAssociationResult
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.
2083 2084 2085 2086 |
# File 'lib/aws-sdk-ssm/client.rb', line 2083 def describe_association(params = {}, = {}) req = build_request(:describe_association, params) req.send_request() end |
#describe_association_execution_targets(params = {}) ⇒ Types::DescribeAssociationExecutionTargetsResult
Use this API action to view information about a specific execution of a specific association.
2156 2157 2158 2159 |
# File 'lib/aws-sdk-ssm/client.rb', line 2156 def describe_association_execution_targets(params = {}, = {}) req = build_request(:describe_association_execution_targets, params) req.send_request() end |
#describe_association_executions(params = {}) ⇒ Types::DescribeAssociationExecutionsResult
Use this API action to view all executions for a specific association ID.
2224 2225 2226 2227 |
# File 'lib/aws-sdk-ssm/client.rb', line 2224 def describe_association_executions(params = {}, = {}) req = build_request(:describe_association_executions, params) req.send_request() end |
#describe_automation_executions(params = {}) ⇒ Types::DescribeAutomationExecutionsResult
Provides details about all active and terminated Automation executions.
2303 2304 2305 2306 |
# File 'lib/aws-sdk-ssm/client.rb', line 2303 def describe_automation_executions(params = {}, = {}) req = build_request(:describe_automation_executions, params) req.send_request() end |
#describe_automation_step_executions(params = {}) ⇒ Types::DescribeAutomationStepExecutionsResult
Information about all active and terminated step executions in an Automation workflow.
2402 2403 2404 2405 |
# File 'lib/aws-sdk-ssm/client.rb', line 2402 def describe_automation_step_executions(params = {}, = {}) req = build_request(:describe_automation_step_executions, params) req.send_request() end |
#describe_available_patches(params = {}) ⇒ Types::DescribeAvailablePatchesResult
Lists all patches eligible to be included in a patch baseline.
2459 2460 2461 2462 |
# File 'lib/aws-sdk-ssm/client.rb', line 2459 def describe_available_patches(params = {}, = {}) req = build_request(:describe_available_patches, params) req.send_request() end |
#describe_document(params = {}) ⇒ Types::DescribeDocumentResult
Describes the specified Systems Manager document.
2529 2530 2531 2532 |
# File 'lib/aws-sdk-ssm/client.rb', line 2529 def describe_document(params = {}, = {}) req = build_request(:describe_document, params) req.send_request() end |
#describe_document_permission(params = {}) ⇒ Types::DescribeDocumentPermissionResponse
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).
2570 2571 2572 2573 |
# File 'lib/aws-sdk-ssm/client.rb', line 2570 def (params = {}, = {}) req = build_request(:describe_document_permission, params) req.send_request() end |
#describe_effective_instance_associations(params = {}) ⇒ Types::DescribeEffectiveInstanceAssociationsResult
All associations for the instance(s).
2615 2616 2617 2618 |
# File 'lib/aws-sdk-ssm/client.rb', line 2615 def describe_effective_instance_associations(params = {}, = {}) req = build_request(:describe_effective_instance_associations, params) req.send_request() end |
#describe_effective_patches_for_patch_baseline(params = {}) ⇒ Types::DescribeEffectivePatchesForPatchBaselineResult
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.
2672 2673 2674 2675 |
# File 'lib/aws-sdk-ssm/client.rb', line 2672 def describe_effective_patches_for_patch_baseline(params = {}, = {}) req = build_request(:describe_effective_patches_for_patch_baseline, params) req.send_request() end |
#describe_instance_associations_status(params = {}) ⇒ Types::DescribeInstanceAssociationsStatusResult
The status of the associations for the instance(s).
2725 2726 2727 2728 |
# File 'lib/aws-sdk-ssm/client.rb', line 2725 def describe_instance_associations_status(params = {}, = {}) req = build_request(:describe_instance_associations_status, params) req.send_request() end |
#describe_instance_information(params = {}) ⇒ Types::DescribeInstanceInformationResult
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.
<note markdown=“1”> 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.
</note>
2822 2823 2824 2825 |
# File 'lib/aws-sdk-ssm/client.rb', line 2822 def describe_instance_information(params = {}, = {}) req = build_request(:describe_instance_information, params) req.send_request() end |
#describe_instance_patch_states(params = {}) ⇒ Types::DescribeInstancePatchStatesResult
Retrieves the high-level patch state of one or more instances.
2881 2882 2883 2884 |
# File 'lib/aws-sdk-ssm/client.rb', line 2881 def describe_instance_patch_states(params = {}, = {}) req = build_request(:describe_instance_patch_states, params) req.send_request() end |
#describe_instance_patch_states_for_patch_group(params = {}) ⇒ Types::DescribeInstancePatchStatesForPatchGroupResult
Retrieves the high-level patch state for the instances in the specified patch group.
2957 2958 2959 2960 |
# File 'lib/aws-sdk-ssm/client.rb', line 2957 def describe_instance_patch_states_for_patch_group(params = {}, = {}) req = build_request(:describe_instance_patch_states_for_patch_group, params) req.send_request() end |
#describe_instance_patches(params = {}) ⇒ Types::DescribeInstancePatchesResult
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
3016 3017 3018 3019 |
# File 'lib/aws-sdk-ssm/client.rb', line 3016 def describe_instance_patches(params = {}, = {}) req = build_request(:describe_instance_patches, params) req.send_request() end |
#describe_inventory_deletions(params = {}) ⇒ Types::DescribeInventoryDeletionsResult
Describes a specific delete inventory operation.
3070 3071 3072 3073 |
# File 'lib/aws-sdk-ssm/client.rb', line 3070 def describe_inventory_deletions(params = {}, = {}) req = build_request(:describe_inventory_deletions, params) req.send_request() end |
#describe_maintenance_window_execution_task_invocations(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionTaskInvocationsResult
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
3140 3141 3142 3143 |
# File 'lib/aws-sdk-ssm/client.rb', line 3140 def describe_maintenance_window_execution_task_invocations(params = {}, = {}) req = build_request(:describe_maintenance_window_execution_task_invocations, params) req.send_request() end |
#describe_maintenance_window_execution_tasks(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionTasksResult
For a given maintenance window execution, lists the tasks that were run.
3202 3203 3204 3205 |
# File 'lib/aws-sdk-ssm/client.rb', line 3202 def describe_maintenance_window_execution_tasks(params = {}, = {}) req = build_request(:describe_maintenance_window_execution_tasks, params) req.send_request() end |
#describe_maintenance_window_executions(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionsResult
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.
3268 3269 3270 3271 |
# File 'lib/aws-sdk-ssm/client.rb', line 3268 def describe_maintenance_window_executions(params = {}, = {}) req = build_request(:describe_maintenance_window_executions, params) req.send_request() end |
#describe_maintenance_window_schedule(params = {}) ⇒ Types::DescribeMaintenanceWindowScheduleResult
Retrieves information about upcoming executions of a maintenance window.
3338 3339 3340 3341 |
# File 'lib/aws-sdk-ssm/client.rb', line 3338 def describe_maintenance_window_schedule(params = {}, = {}) req = build_request(:describe_maintenance_window_schedule, params) req.send_request() end |
#describe_maintenance_window_targets(params = {}) ⇒ Types::DescribeMaintenanceWindowTargetsResult
Lists the targets registered with the maintenance window.
3400 3401 3402 3403 |
# File 'lib/aws-sdk-ssm/client.rb', line 3400 def describe_maintenance_window_targets(params = {}, = {}) req = build_request(:describe_maintenance_window_targets, params) req.send_request() end |
#describe_maintenance_window_tasks(params = {}) ⇒ Types::DescribeMaintenanceWindowTasksResult
Lists the tasks in a maintenance window.
3472 3473 3474 3475 |
# File 'lib/aws-sdk-ssm/client.rb', line 3472 def describe_maintenance_window_tasks(params = {}, = {}) req = build_request(:describe_maintenance_window_tasks, params) req.send_request() end |
#describe_maintenance_windows(params = {}) ⇒ Types::DescribeMaintenanceWindowsResult
Retrieves the maintenance windows in an AWS account.
3531 3532 3533 3534 |
# File 'lib/aws-sdk-ssm/client.rb', line 3531 def describe_maintenance_windows(params = {}, = {}) req = build_request(:describe_maintenance_windows, params) req.send_request() end |
#describe_maintenance_windows_for_target(params = {}) ⇒ Types::DescribeMaintenanceWindowsForTargetResult
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
3585 3586 3587 3588 |
# File 'lib/aws-sdk-ssm/client.rb', line 3585 def describe_maintenance_windows_for_target(params = {}, = {}) req = build_request(:describe_maintenance_windows_for_target, params) req.send_request() end |
#describe_ops_items(params = {}) ⇒ Types::DescribeOpsItemsResponse
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see [Getting Started with OpsCenter] in the *AWS Systems Manager User Guide*.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter] in the *AWS Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
3716 3717 3718 3719 |
# File 'lib/aws-sdk-ssm/client.rb', line 3716 def describe_ops_items(params = {}, = {}) req = build_request(:describe_ops_items, params) req.send_request() end |
#describe_parameters(params = {}) ⇒ Types::DescribeParametersResult
Get information about a parameter.
<note markdown=“1”> 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.
</note>
3796 3797 3798 3799 |
# File 'lib/aws-sdk-ssm/client.rb', line 3796 def describe_parameters(params = {}, = {}) req = build_request(:describe_parameters, params) req.send_request() end |
#describe_patch_baselines(params = {}) ⇒ Types::DescribePatchBaselinesResult
Lists the patch baselines in your AWS account.
3850 3851 3852 3853 |
# File 'lib/aws-sdk-ssm/client.rb', line 3850 def describe_patch_baselines(params = {}, = {}) req = build_request(:describe_patch_baselines, params) req.send_request() end |
#describe_patch_group_state(params = {}) ⇒ Types::DescribePatchGroupStateResult
Returns high-level aggregated patch compliance state for a patch group.
3895 3896 3897 3898 |
# File 'lib/aws-sdk-ssm/client.rb', line 3895 def describe_patch_group_state(params = {}, = {}) req = build_request(:describe_patch_group_state, params) req.send_request() end |
#describe_patch_groups(params = {}) ⇒ Types::DescribePatchGroupsResult
Lists all patch groups that have been registered with patch baselines.
3946 3947 3948 3949 |
# File 'lib/aws-sdk-ssm/client.rb', line 3946 def describe_patch_groups(params = {}, = {}) req = build_request(:describe_patch_groups, params) req.send_request() end |
#describe_patch_properties(params = {}) ⇒ Types::DescribePatchPropertiesResult
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
WINDOWS
: Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION,
MSRC\_SEVERITY
AMAZON_LINUX
: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
AMAZON_LINUX_2
: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
UBUNTU
: Valid properties: PRODUCT, PRIORITY
REDHAT_ENTERPRISE_LINUX
: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
SUSE
: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
CENTOS
: Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
4036 4037 4038 4039 |
# File 'lib/aws-sdk-ssm/client.rb', line 4036 def describe_patch_properties(params = {}, = {}) req = build_request(:describe_patch_properties, params) req.send_request() end |
#describe_sessions(params = {}) ⇒ Types::DescribeSessionsResponse
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
4099 4100 4101 4102 |
# File 'lib/aws-sdk-ssm/client.rb', line 4099 def describe_sessions(params = {}, = {}) req = build_request(:describe_sessions, params) req.send_request() end |
#get_automation_execution(params = {}) ⇒ Types::GetAutomationExecutionResult
Get detailed information about a particular Automation execution.
4217 4218 4219 4220 |
# File 'lib/aws-sdk-ssm/client.rb', line 4217 def get_automation_execution(params = {}, = {}) req = build_request(:get_automation_execution, params) req.send_request() end |
#get_command_invocation(params = {}) ⇒ Types::GetCommandInvocationResult
Returns detailed information about command execution for an invocation or plugin.
4291 4292 4293 4294 |
# File 'lib/aws-sdk-ssm/client.rb', line 4291 def get_command_invocation(params = {}, = {}) req = build_request(:get_command_invocation, params) req.send_request() end |
#get_connection_status(params = {}) ⇒ Types::GetConnectionStatusResponse
Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
4323 4324 4325 4326 |
# File 'lib/aws-sdk-ssm/client.rb', line 4323 def get_connection_status(params = {}, = {}) req = build_request(:get_connection_status, params) req.send_request() end |
#get_default_patch_baseline(params = {}) ⇒ Types::GetDefaultPatchBaselineResult
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.
4358 4359 4360 4361 |
# File 'lib/aws-sdk-ssm/client.rb', line 4358 def get_default_patch_baseline(params = {}, = {}) req = build_request(:get_default_patch_baseline, params) req.send_request() end |
#get_deployable_patch_snapshot_for_instance(params = {}) ⇒ Types::GetDeployablePatchSnapshotForInstanceResult
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
4399 4400 4401 4402 |
# File 'lib/aws-sdk-ssm/client.rb', line 4399 def get_deployable_patch_snapshot_for_instance(params = {}, = {}) req = build_request(:get_deployable_patch_snapshot_for_instance, params) req.send_request() end |
#get_document(params = {}) ⇒ Types::GetDocumentResult
Gets the contents of the specified Systems Manager document.
4467 4468 4469 4470 |
# File 'lib/aws-sdk-ssm/client.rb', line 4467 def get_document(params = {}, = {}) req = build_request(:get_document, params) req.send_request() end |
#get_inventory(params = {}) ⇒ Types::GetInventoryResult
Query inventory information.
4558 4559 4560 4561 |
# File 'lib/aws-sdk-ssm/client.rb', line 4558 def get_inventory(params = {}, = {}) req = build_request(:get_inventory, params) req.send_request() end |
#get_inventory_schema(params = {}) ⇒ Types::GetInventorySchemaResult
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
4617 4618 4619 4620 |
# File 'lib/aws-sdk-ssm/client.rb', line 4617 def get_inventory_schema(params = {}, = {}) req = build_request(:get_inventory_schema, params) req.send_request() end |
#get_maintenance_window(params = {}) ⇒ Types::GetMaintenanceWindowResult
Retrieves a maintenance window.
4672 4673 4674 4675 |
# File 'lib/aws-sdk-ssm/client.rb', line 4672 def get_maintenance_window(params = {}, = {}) req = build_request(:get_maintenance_window, params) req.send_request() end |
#get_maintenance_window_execution(params = {}) ⇒ Types::GetMaintenanceWindowExecutionResult
Retrieves details about a specific a maintenance window execution.
4711 4712 4713 4714 |
# File 'lib/aws-sdk-ssm/client.rb', line 4711 def get_maintenance_window_execution(params = {}, = {}) req = build_request(:get_maintenance_window_execution, params) req.send_request() end |
#get_maintenance_window_execution_task(params = {}) ⇒ Types::GetMaintenanceWindowExecutionTaskResult
Retrieves the details about a specific task run as part of a maintenance window execution.
4772 4773 4774 4775 |
# File 'lib/aws-sdk-ssm/client.rb', line 4772 def get_maintenance_window_execution_task(params = {}, = {}) req = build_request(:get_maintenance_window_execution_task, params) req.send_request() end |
#get_maintenance_window_execution_task_invocation(params = {}) ⇒ Types::GetMaintenanceWindowExecutionTaskInvocationResult
Retrieves information about a specific task running on a specific target.
4833 4834 4835 4836 |
# File 'lib/aws-sdk-ssm/client.rb', line 4833 def get_maintenance_window_execution_task_invocation(params = {}, = {}) req = build_request(:get_maintenance_window_execution_task_invocation, params) req.send_request() end |
#get_maintenance_window_task(params = {}) ⇒ Types::GetMaintenanceWindowTaskResult
Lists the tasks in a maintenance window.
4920 4921 4922 4923 |
# File 'lib/aws-sdk-ssm/client.rb', line 4920 def get_maintenance_window_task(params = {}, = {}) req = build_request(:get_maintenance_window_task, params) req.send_request() end |
#get_ops_item(params = {}) ⇒ Types::GetOpsItemResponse
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see [Getting Started with OpsCenter] in the *AWS Systems Manager User Guide*.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter] in the *AWS Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
4981 4982 4983 4984 |
# File 'lib/aws-sdk-ssm/client.rb', line 4981 def get_ops_item(params = {}, = {}) req = build_request(:get_ops_item, params) req.send_request() end |
#get_ops_summary(params = {}) ⇒ Types::GetOpsSummaryResult
View a summary of OpsItems based on specified filters and aggregators.
5070 5071 5072 5073 |
# File 'lib/aws-sdk-ssm/client.rb', line 5070 def get_ops_summary(params = {}, = {}) req = build_request(:get_ops_summary, params) req.send_request() end |
#get_parameter(params = {}) ⇒ Types::GetParameterResult
Get information about a parameter by using the parameter name. Don’t confuse this API action with the GetParameters API action.
5111 5112 5113 5114 |
# File 'lib/aws-sdk-ssm/client.rb', line 5111 def get_parameter(params = {}, = {}) req = build_request(:get_parameter, params) req.send_request() end |
#get_parameter_history(params = {}) ⇒ Types::GetParameterHistoryResult
Query a list of all parameters used by the AWS account.
5173 5174 5175 5176 |
# File 'lib/aws-sdk-ssm/client.rb', line 5173 def get_parameter_history(params = {}, = {}) req = build_request(:get_parameter_history, params) req.send_request() end |
#get_parameters(params = {}) ⇒ Types::GetParametersResult
Get details of a parameter. Don’t confuse this API action with the GetParameter API action.
5219 5220 5221 5222 |
# File 'lib/aws-sdk-ssm/client.rb', line 5219 def get_parameters(params = {}, = {}) req = build_request(:get_parameters, params) req.send_request() end |
#get_parameters_by_path(params = {}) ⇒ Types::GetParametersByPathResult
Retrieve information about one or more parameters in a specific hierarchy.
<note markdown=“1”> 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.
</note>
5308 5309 5310 5311 |
# File 'lib/aws-sdk-ssm/client.rb', line 5308 def get_parameters_by_path(params = {}, = {}) req = build_request(:get_parameters_by_path, params) req.send_request() end |
#get_patch_baseline(params = {}) ⇒ Types::GetPatchBaselineResult
Retrieves information about a patch baseline.
5381 5382 5383 5384 |
# File 'lib/aws-sdk-ssm/client.rb', line 5381 def get_patch_baseline(params = {}, = {}) req = build_request(:get_patch_baseline, params) req.send_request() end |
#get_patch_baseline_for_patch_group(params = {}) ⇒ Types::GetPatchBaselineForPatchGroupResult
Retrieves the patch baseline that should be used for the specified patch group.
5419 5420 5421 5422 |
# File 'lib/aws-sdk-ssm/client.rb', line 5419 def get_patch_baseline_for_patch_group(params = {}, = {}) req = build_request(:get_patch_baseline_for_patch_group, params) req.send_request() end |
#get_service_setting(params = {}) ⇒ Types::GetServiceSettingResult
‘ServiceSetting` is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of “false”. This means the user can’t use this feature unless they change the setting to “true” and intentionally opt in for a paid feature.
Services map a ‘SettingId` object to a setting value. AWS services teams define the default value for a `SettingId`. You can’t create a new ‘SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
5468 5469 5470 5471 |
# File 'lib/aws-sdk-ssm/client.rb', line 5468 def get_service_setting(params = {}, = {}) req = build_request(:get_service_setting, params) req.send_request() end |
#label_parameter_version(params = {}) ⇒ Types::LabelParameterVersionResult
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
-
A version of a parameter can have a maximum of 10 labels.
-
You can’t attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can’t attach Production to version 2.
-
You can move a label from one version of a parameter to another.
-
You can’t create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
-
You can’t delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
-
A label can have a maximum of 100 characters.
-
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
-
Labels can’t begin with a number, “aws,” or “ssm” (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
5540 5541 5542 5543 |
# File 'lib/aws-sdk-ssm/client.rb', line 5540 def label_parameter_version(params = {}, = {}) req = build_request(:label_parameter_version, params) req.send_request() end |
#list_association_versions(params = {}) ⇒ Types::ListAssociationVersionsResult
Retrieves all versions of an association for a specific association ID.
5602 5603 5604 5605 |
# File 'lib/aws-sdk-ssm/client.rb', line 5602 def list_association_versions(params = {}, = {}) req = build_request(:list_association_versions, params) req.send_request() end |
#list_associations(params = {}) ⇒ Types::ListAssociationsResult
Lists the associations for the specified Systems Manager document or instance.
5666 5667 5668 5669 |
# File 'lib/aws-sdk-ssm/client.rb', line 5666 def list_associations(params = {}, = {}) req = build_request(:list_associations, params) req.send_request() end |
#list_command_invocations(params = {}) ⇒ Types::ListCommandInvocationsResult
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
5764 5765 5766 5767 |
# File 'lib/aws-sdk-ssm/client.rb', line 5764 def list_command_invocations(params = {}, = {}) req = build_request(:list_command_invocations, params) req.send_request() end |
#list_commands(params = {}) ⇒ Types::ListCommandsResult
Lists the commands requested by users of the AWS account.
5852 5853 5854 5855 |
# File 'lib/aws-sdk-ssm/client.rb', line 5852 def list_commands(params = {}, = {}) req = build_request(:list_commands, params) req.send_request() end |
#list_compliance_items(params = {}) ⇒ Types::ListComplianceItemsResult
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.
5925 5926 5927 5928 |
# File 'lib/aws-sdk-ssm/client.rb', line 5925 def list_compliance_items(params = {}, = {}) req = build_request(:list_compliance_items, params) req.send_request() end |
#list_compliance_summaries(params = {}) ⇒ Types::ListComplianceSummariesResult
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.
5991 5992 5993 5994 |
# File 'lib/aws-sdk-ssm/client.rb', line 5991 def list_compliance_summaries(params = {}, = {}) req = build_request(:list_compliance_summaries, params) req.send_request() end |
#list_document_versions(params = {}) ⇒ Types::ListDocumentVersionsResult
List all versions for a document.
6041 6042 6043 6044 |
# File 'lib/aws-sdk-ssm/client.rb', line 6041 def list_document_versions(params = {}, = {}) req = build_request(:list_document_versions, params) req.send_request() end |
#list_documents(params = {}) ⇒ Types::ListDocumentsResult
Describes one or more of your Systems Manager documents.
6114 6115 6116 6117 |
# File 'lib/aws-sdk-ssm/client.rb', line 6114 def list_documents(params = {}, = {}) req = build_request(:list_documents, params) req.send_request() end |
#list_inventory_entries(params = {}) ⇒ Types::ListInventoryEntriesResult
A list of inventory items returned by the request.
6180 6181 6182 6183 |
# File 'lib/aws-sdk-ssm/client.rb', line 6180 def list_inventory_entries(params = {}, = {}) req = build_request(:list_inventory_entries, params) req.send_request() end |
#list_resource_compliance_summaries(params = {}) ⇒ Types::ListResourceComplianceSummariesResult
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.
6253 6254 6255 6256 |
# File 'lib/aws-sdk-ssm/client.rb', line 6253 def list_resource_compliance_summaries(params = {}, = {}) req = build_request(:list_resource_compliance_summaries, params) req.send_request() end |
#list_resource_data_sync(params = {}) ⇒ Types::ListResourceDataSyncResult
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.
6329 6330 6331 6332 |
# File 'lib/aws-sdk-ssm/client.rb', line 6329 def list_resource_data_sync(params = {}, = {}) req = build_request(:list_resource_data_sync, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Returns a list of the tags assigned to the specified resource.
6363 6364 6365 6366 |
# File 'lib/aws-sdk-ssm/client.rb', line 6363 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#modify_document_permission(params = {}) ⇒ Struct
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.
6411 6412 6413 6414 |
# File 'lib/aws-sdk-ssm/client.rb', line 6411 def (params = {}, = {}) req = build_request(:modify_document_permission, params) req.send_request() end |
#put_compliance_items(params = {}) ⇒ Struct
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’
6521 6522 6523 6524 |
# File 'lib/aws-sdk-ssm/client.rb', line 6521 def put_compliance_items(params = {}, = {}) req = build_request(:put_compliance_items, params) req.send_request() end |
#put_inventory(params = {}) ⇒ Types::PutInventoryResult
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.
6570 6571 6572 6573 |
# File 'lib/aws-sdk-ssm/client.rb', line 6570 def put_inventory(params = {}, = {}) req = build_request(:put_inventory, params) req.send_request() end |
#put_parameter(params = {}) ⇒ Types::PutParameterResult
Add a parameter to the system.
6826 6827 6828 6829 |
# File 'lib/aws-sdk-ssm/client.rb', line 6826 def put_parameter(params = {}, = {}) req = build_request(:put_parameter, params) req.send_request() end |
#register_default_patch_baseline(params = {}) ⇒ Types::RegisterDefaultPatchBaselineResult
Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify ‘arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed` instead of `pb-0574b43a65ea646ed`.
6861 6862 6863 6864 |
# File 'lib/aws-sdk-ssm/client.rb', line 6861 def register_default_patch_baseline(params = {}, = {}) req = build_request(:register_default_patch_baseline, params) req.send_request() end |
#register_patch_baseline_for_patch_group(params = {}) ⇒ Types::RegisterPatchBaselineForPatchGroupResult
Registers a patch baseline for a patch group.
6896 6897 6898 6899 |
# File 'lib/aws-sdk-ssm/client.rb', line 6896 def register_patch_baseline_for_patch_group(params = {}, = {}) req = build_request(:register_patch_baseline_for_patch_group, params) req.send_request() end |
#register_target_with_maintenance_window(params = {}) ⇒ Types::RegisterTargetWithMaintenanceWindowResult
Registers a target with a maintenance window.
6999 7000 7001 7002 |
# File 'lib/aws-sdk-ssm/client.rb', line 6999 def register_target_with_maintenance_window(params = {}, = {}) req = build_request(:register_target_with_maintenance_window, params) req.send_request() end |
#register_task_with_maintenance_window(params = {}) ⇒ Types::RegisterTaskWithMaintenanceWindowResult
Adds a new task to a maintenance window.
7177 7178 7179 7180 |
# File 'lib/aws-sdk-ssm/client.rb', line 7177 def register_task_with_maintenance_window(params = {}, = {}) req = build_request(:register_task_with_maintenance_window, params) req.send_request() end |
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes tag keys from the specified resource.
7228 7229 7230 7231 |
# File 'lib/aws-sdk-ssm/client.rb', line 7228 def (params = {}, = {}) req = build_request(:remove_tags_from_resource, params) req.send_request() end |
#reset_service_setting(params = {}) ⇒ Types::ResetServiceSettingResult
‘ServiceSetting` is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of “false”. This means the user can’t use this feature unless they change the setting to “true” and intentionally opt in for a paid feature.
Services map a ‘SettingId` object to a setting value. AWS services teams define the default value for a `SettingId`. You can’t create a new ‘SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
7277 7278 7279 7280 |
# File 'lib/aws-sdk-ssm/client.rb', line 7277 def reset_service_setting(params = {}, = {}) req = build_request(:reset_service_setting, params) req.send_request() end |
#resume_session(params = {}) ⇒ Types::ResumeSessionResponse
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
<note markdown=“1”> This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
</note>
7317 7318 7319 7320 |
# File 'lib/aws-sdk-ssm/client.rb', line 7317 def resume_session(params = {}, = {}) req = build_request(:resume_session, params) req.send_request() end |
#send_automation_signal(params = {}) ⇒ Struct
Sends a signal to an Automation execution to change the current behavior or status of the execution.
7367 7368 7369 7370 |
# File 'lib/aws-sdk-ssm/client.rb', line 7367 def send_automation_signal(params = {}, = {}) req = build_request(:send_automation_signal, params) req.send_request() end |
#send_command(params = {}) ⇒ Types::SendCommandResult
Runs commands on one or more managed instances.
7569 7570 7571 7572 |
# File 'lib/aws-sdk-ssm/client.rb', line 7569 def send_command(params = {}, = {}) req = build_request(:send_command, params) req.send_request() end |
#start_associations_once(params = {}) ⇒ Struct
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
7593 7594 7595 7596 |
# File 'lib/aws-sdk-ssm/client.rb', line 7593 def start_associations_once(params = {}, = {}) req = build_request(:start_associations_once, params) req.send_request() end |
#start_automation_execution(params = {}) ⇒ Types::StartAutomationExecutionResult
Initiates execution of an Automation document.
7711 7712 7713 7714 |
# File 'lib/aws-sdk-ssm/client.rb', line 7711 def start_automation_execution(params = {}, = {}) req = build_request(:start_automation_execution, params) req.send_request() end |
#start_session(params = {}) ⇒ Types::StartSessionResponse
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
<note markdown=“1”> AWS CLI usage: ‘start-session` is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see [ Install the Session Manager Plugin for the AWS CLI] in the *AWS Systems Manager User Guide*.
AWS Tools for PowerShell usage: Start-SSMSession is not currently
supported by AWS Tools for PowerShell on Windows local machines.
</note>
7772 7773 7774 7775 |
# File 'lib/aws-sdk-ssm/client.rb', line 7772 def start_session(params = {}, = {}) req = build_request(:start_session, params) req.send_request() end |
#stop_automation_execution(params = {}) ⇒ Struct
Stop an Automation that is currently running.
7799 7800 7801 7802 |
# File 'lib/aws-sdk-ssm/client.rb', line 7799 def stop_automation_execution(params = {}, = {}) req = build_request(:stop_automation_execution, params) req.send_request() end |
#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
7829 7830 7831 7832 |
# File 'lib/aws-sdk-ssm/client.rb', line 7829 def terminate_session(params = {}, = {}) req = build_request(:terminate_session, params) req.send_request() end |
#update_association(params = {}) ⇒ Types::UpdateAssociationResult
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation API action. If you don’t have permission to call DescribeAssociation, then you receive the following error: ‘An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>`
When you update an association, the association immediately runs against the specified targets.
8014 8015 8016 8017 |
# File 'lib/aws-sdk-ssm/client.rb', line 8014 def update_association(params = {}, = {}) req = build_request(:update_association, params) req.send_request() end |
#update_association_status(params = {}) ⇒ Types::UpdateAssociationStatusResult
Updates the status of the Systems Manager document associated with the specified instance.
8088 8089 8090 8091 |
# File 'lib/aws-sdk-ssm/client.rb', line 8088 def update_association_status(params = {}, = {}) req = build_request(:update_association_status, params) req.send_request() end |
#update_document(params = {}) ⇒ Types::UpdateDocumentResult
Updates one or more values for an SSM document.
8182 8183 8184 8185 |
# File 'lib/aws-sdk-ssm/client.rb', line 8182 def update_document(params = {}, = {}) req = build_request(:update_document, params) req.send_request() end |
#update_document_default_version(params = {}) ⇒ Types::UpdateDocumentDefaultVersionResult
Set the default version of a document.
8218 8219 8220 8221 |
# File 'lib/aws-sdk-ssm/client.rb', line 8218 def update_document_default_version(params = {}, = {}) req = build_request(:update_document_default_version, params) req.send_request() end |
#update_maintenance_window(params = {}) ⇒ Types::UpdateMaintenanceWindowResult
Updates an existing maintenance window. Only specified parameters are modified.
<note markdown=“1”> The value you specify for ‘Duration` determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for `Cutoff`. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for `Cutoff` is one hour, no maintenance window tasks can start after 5 PM.
</note>
8343 8344 8345 8346 |
# File 'lib/aws-sdk-ssm/client.rb', line 8343 def update_maintenance_window(params = {}, = {}) req = build_request(:update_maintenance_window, params) req.send_request() end |
#update_maintenance_window_target(params = {}) ⇒ Types::UpdateMaintenanceWindowTargetResult
Modifies the target of an existing maintenance window. You can change the following:
-
Name
-
Description
-
Owner
-
IDs for an ID target
-
Tags for a Tag target
-
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
<note markdown=“1”> If a parameter is null, then the corresponding field is not modified.
</note>
8436 8437 8438 8439 |
# File 'lib/aws-sdk-ssm/client.rb', line 8436 def update_maintenance_window_target(params = {}, = {}) req = build_request(:update_maintenance_window_target, params) req.send_request() end |
#update_maintenance_window_task(params = {}) ⇒ Types::UpdateMaintenanceWindowTaskResult
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.
8686 8687 8688 8689 |
# File 'lib/aws-sdk-ssm/client.rb', line 8686 def update_maintenance_window_task(params = {}, = {}) req = build_request(:update_maintenance_window_task, params) req.send_request() end |
#update_managed_instance_role(params = {}) ⇒ Struct
Assigns or changes an Amazon Identity and Access Management (IAM) role for the managed instance.
8713 8714 8715 8716 |
# File 'lib/aws-sdk-ssm/client.rb', line 8713 def update_managed_instance_role(params = {}, = {}) req = build_request(:update_managed_instance_role, params) req.send_request() end |
#update_ops_item(params = {}) ⇒ Struct
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see [Getting Started with OpsCenter] in the *AWS Systems Manager User Guide*.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see [AWS Systems Manager OpsCenter] in the *AWS Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-getting-started.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
8844 8845 8846 8847 |
# File 'lib/aws-sdk-ssm/client.rb', line 8844 def update_ops_item(params = {}, = {}) req = build_request(:update_ops_item, params) req.send_request() end |
#update_patch_baseline(params = {}) ⇒ Types::UpdatePatchBaselineResult
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
<note markdown=“1”> For information about valid key and value pairs in ‘PatchFilters` for each supported operating system type, see [PatchFilter].
</note>
[1]: docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html
9032 9033 9034 9035 |
# File 'lib/aws-sdk-ssm/client.rb', line 9032 def update_patch_baseline(params = {}, = {}) req = build_request(:update_patch_baseline, params) req.send_request() end |
#update_resource_data_sync(params = {}) ⇒ Struct
Update a resource data sync. After you create a resource data sync for a Region, you can’t change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can’t edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
9083 9084 9085 9086 |
# File 'lib/aws-sdk-ssm/client.rb', line 9083 def update_resource_data_sync(params = {}, = {}) req = build_request(:update_resource_data_sync, params) req.send_request() end |
#update_service_setting(params = {}) ⇒ Struct
‘ServiceSetting` is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of “false”. This means the user can’t use this feature unless they change the setting to “true” and intentionally opt in for a paid feature.
Services map a ‘SettingId` object to a setting value. AWS services teams define the default value for a `SettingId`. You can’t create a new ‘SettingId`, but you can overwrite the default value if you have the `ssm:UpdateServiceSetting` permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.
Update the service setting for the account.
9125 9126 9127 9128 |
# File 'lib/aws-sdk-ssm/client.rb', line 9125 def update_service_setting(params = {}, = {}) req = build_request(:update_service_setting, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9149 9150 9151 |
# File 'lib/aws-sdk-ssm/client.rb', line 9149 def waiter_names [] end |