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
Overview
An API client for SSM. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::SSM::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
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.
-
#associate_ops_item_related_item(params = {}) ⇒ Types::AssociateOpsItemRelatedItemResponse
Associates a related item to a Systems Manager OpsCenter OpsItem.
-
#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 haven’t already starting running.
-
#create_activation(params = {}) ⇒ Types::CreateActivationResult
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.
-
#create_association(params = {}) ⇒ Types::CreateAssociationResult
A State Manager association defines the state that you want to maintain on your managed nodes.
-
#create_association_batch(params = {}) ⇒ Types::CreateAssociationBatchResult
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
-
#create_document(params = {}) ⇒ Types::CreateDocumentResult
Creates a Amazon Web Services Systems Manager (SSM document).
-
#create_maintenance_window(params = {}) ⇒ Types::CreateMaintenanceWindowResult
Creates a new maintenance window.
-
#create_ops_item(params = {}) ⇒ Types::CreateOpsItemResponse
Creates a new OpsItem.
-
#create_ops_metadata(params = {}) ⇒ Types::CreateOpsMetadataResult
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
-
#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 Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
-
#delete_document(params = {}) ⇒ Struct
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node 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_ops_item(params = {}) ⇒ Struct
Delete an OpsItem.
-
#delete_ops_metadata(params = {}) ⇒ Struct
Delete OpsMetadata related to an application.
-
#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.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a Systems Manager resource policy.
-
#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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
-
#describe_association(params = {}) ⇒ Types::DescribeAssociationResult
Describes the association for the specified target or managed node.
-
#describe_association_execution_targets(params = {}) ⇒ Types::DescribeAssociationExecutionTargetsResult
Views information about a specific execution of a specific association.
-
#describe_association_executions(params = {}) ⇒ Types::DescribeAssociationExecutionsResult
Views 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 Amazon Web Services Systems Manager document (SSM document).
-
#describe_document_permission(params = {}) ⇒ Types::DescribeDocumentPermissionResponse
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).
-
#describe_effective_instance_associations(params = {}) ⇒ Types::DescribeEffectiveInstanceAssociationsResult
All associations for the managed node(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 managed node(s).
-
#describe_instance_information(params = {}) ⇒ Types::DescribeInstanceInformationResult
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address.
-
#describe_instance_patch_states(params = {}) ⇒ Types::DescribeInstancePatchStatesResult
Retrieves the high-level patch state of one or more managed nodes.
-
#describe_instance_patch_states_for_patch_group(params = {}) ⇒ Types::DescribeInstancePatchStatesForPatchGroupResult
Retrieves the high-level patch state for the managed nodes in the specified patch group.
-
#describe_instance_patches(params = {}) ⇒ Types::DescribeInstancePatchesResult
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
-
#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 Amazon Web Services account.
-
#describe_maintenance_windows_for_target(params = {}) ⇒ Types::DescribeMaintenanceWindowsForTargetResult
Retrieves information about the maintenance window targets or tasks that a managed node 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 Amazon Web Services account.
-
#describe_patch_group_state(params = {}) ⇒ Types::DescribePatchGroupStateResult
Returns high-level aggregated patch compliance state information 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.
-
#disassociate_ops_item_related_item(params = {}) ⇒ Struct
Deletes the association between an OpsItem and a related item.
-
#get_automation_execution(params = {}) ⇒ Types::GetAutomationExecutionResult
Get detailed information about a particular Automation execution.
-
#get_calendar_state(params = {}) ⇒ Types::GetCalendarStateResponse
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
-
#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 a managed node to determine whether it is running 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 managed node uses.
-
#get_document(params = {}) ⇒ Types::GetDocumentResult
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM 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
Retrieves the details of a maintenance window task.
-
#get_ops_item(params = {}) ⇒ Types::GetOpsItemResponse
Get information about an OpsItem by using the ID.
-
#get_ops_metadata(params = {}) ⇒ Types::GetOpsMetadataResult
View operational metadata related to an application in Application Manager.
-
#get_ops_summary(params = {}) ⇒ Types::GetOpsSummaryResult
View a summary of operations metadata (OpsData) based on specified filters and aggregators.
-
#get_parameter(params = {}) ⇒ Types::GetParameterResult
Get information about a single parameter by specifying the parameter name.
-
#get_parameter_history(params = {}) ⇒ Types::GetParameterHistoryResult
Retrieves the history of all changes to a parameter.
-
#get_parameters(params = {}) ⇒ Types::GetParametersResult
Get information about one or more parameters by specifying multiple parameter names.
-
#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_resource_policies(params = {}) ⇒ Types::GetResourcePoliciesResponse
Returns an array of the ‘Policy` object.
-
#get_service_setting(params = {}) ⇒ Types::GetServiceSettingResult
‘ServiceSetting` is an account-level setting for an Amazon Web Services 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
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
-
#list_command_invocations(params = {}) ⇒ Types::ListCommandInvocationsResult
An invocation is copy of a command sent to a specific managed node.
-
#list_commands(params = {}) ⇒ Types::ListCommandsResult
Lists the commands requested by users of the Amazon Web Services account.
-
#list_compliance_items(params = {}) ⇒ Types::ListComplianceItemsResult
For a specified resource ID, this API operation 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_metadata_history(params = {}) ⇒ Types::ListDocumentMetadataHistoryResponse
Information about approval reviews for a version of a change template in Change Manager.
-
#list_document_versions(params = {}) ⇒ Types::ListDocumentVersionsResult
List all versions for a document.
-
#list_documents(params = {}) ⇒ Types::ListDocumentsResult
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region.
-
#list_inventory_entries(params = {}) ⇒ Types::ListInventoryEntriesResult
A list of inventory items returned by the request.
-
#list_ops_item_events(params = {}) ⇒ Types::ListOpsItemEventsResponse
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.
-
#list_ops_item_related_items(params = {}) ⇒ Types::ListOpsItemRelatedItemsResponse
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
-
#list_ops_metadata(params = {}) ⇒ Types::ListOpsMetadataResult
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
-
#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 Amazon Web Services Systems Manager document (SSM 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 or more managed nodes.
-
#put_parameter(params = {}) ⇒ Types::PutParameterResult
Add a parameter to the system.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Creates or updates a Systems Manager resource policy.
-
#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 Amazon Web Services service.
-
#resume_session(params = {}) ⇒ Types::ResumeSessionResponse
Reconnects a session to a managed node 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 nodes.
-
#start_associations_once(params = {}) ⇒ Struct
Runs an association immediately and only one time.
-
#start_automation_execution(params = {}) ⇒ Types::StartAutomationExecutionResult
Initiates execution of an Automation runbook.
-
#start_change_request_execution(params = {}) ⇒ Types::StartChangeRequestExecutionResult
Creates a change request for Change Manager.
-
#start_session(params = {}) ⇒ Types::StartSessionResponse
Initiates a connection to a target (for example, a managed node) 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 managed node.
-
#unlabel_parameter_version(params = {}) ⇒ Types::UnlabelParameterVersionResult
Remove a label or labels from a parameter.
-
#update_association(params = {}) ⇒ Types::UpdateAssociationResult
Updates an association.
-
#update_association_status(params = {}) ⇒ Types::UpdateAssociationStatusResult
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
-
#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_document_metadata(params = {}) ⇒ Struct
Updates information related to approval reviews for a specific version of a change template in Change Manager.
-
#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
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM).
-
#update_ops_item(params = {}) ⇒ Struct
Edit or change an OpsItem.
-
#update_ops_metadata(params = {}) ⇒ Types::UpdateOpsMetadataResult
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
-
#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 Amazon Web Services 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.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-ssm/client.rb', line 395 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.
12386 12387 12388 |
# File 'lib/aws-sdk-ssm/client.rb', line 12386 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.
12389 12390 12391 |
# File 'lib/aws-sdk-ssm/client.rb', line 12389 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 automations, documents, managed nodes, 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 nodes that helps you track each node’s owner and stack level. For example:
-
‘Key=Owner,Value=DbAdmin`
-
‘Key=Owner,Value=SysAdmin`
-
‘Key=Owner,Value=Dev`
-
‘Key=Stack,Value=Production`
-
‘Key=Stack,Value=Pre-Production`
-
‘Key=Stack,Value=Test`
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 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 and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see [Tagging your Amazon EC2 resources] in the *Amazon EC2 User Guide*.
[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html
505 506 507 508 |
# File 'lib/aws-sdk-ssm/client.rb', line 505 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#associate_ops_item_related_item(params = {}) ⇒ Types::AssociateOpsItemRelatedItemResponse
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
557 558 559 560 |
# File 'lib/aws-sdk-ssm/client.rb', line 557 def (params = {}, = {}) req = build_request(:associate_ops_item_related_item, 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.
12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 |
# File 'lib/aws-sdk-ssm/client.rb', line 12251 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.163.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.
587 588 589 590 |
# File 'lib/aws-sdk-ssm/client.rb', line 587 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 haven’t already starting running. Tasks already in progress will continue to completion.
617 618 619 620 |
# File 'lib/aws-sdk-ssm/client.rb', line 617 def cancel_maintenance_window_execution(params = {}, = {}) req = build_request(:cancel_maintenance_window_execution, params) req.send_request() end |
#create_activation(params = {}) ⇒ Types::CreateActivationResult
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see [Setting up Amazon Web Services Systems Manager for hybrid environments] in the *Amazon Web Services Systems Manager User Guide*.
<note markdown=“1”> Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called *managed nodes*.
</note>
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html
748 749 750 751 |
# File 'lib/aws-sdk-ssm/client.rb', line 748 def create_activation(params = {}, = {}) req = build_request(:create_activation, params) req.send_request() end |
#create_association(params = {}) ⇒ Types::CreateAssociationResult
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn’t installed, then State Manager installs it. If the software is installed, but the service isn’t running, then the association might instruct State Manager to start the service.
1095 1096 1097 1098 |
# File 'lib/aws-sdk-ssm/client.rb', line 1095 def create_association(params = {}, = {}) req = build_request(:create_association, params) req.send_request() end |
#create_association_batch(params = {}) ⇒ Types::CreateAssociationBatchResult
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.
If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.
1300 1301 1302 1303 |
# File 'lib/aws-sdk-ssm/client.rb', line 1300 def create_association_batch(params = {}, = {}) req = build_request(:create_association_batch, params) req.send_request() end |
#create_document(params = {}) ⇒ Types::CreateDocumentResult
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see [Amazon Web Services Systems Manager Documents] in the *Amazon Web Services Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html
1510 1511 1512 1513 |
# File 'lib/aws-sdk-ssm/client.rb', line 1510 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>
1649 1650 1651 1652 |
# File 'lib/aws-sdk-ssm/client.rb', line 1649 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 Identity and Access Management (IAM) to create a new OpsItem. For more information, see
- Set up OpsCenter][1
-
in the *Amazon Web Services Systems Manager User
Guide*.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see [Amazon Web Services Systems Manager OpsCenter] in the *Amazon Web Services Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
1852 1853 1854 1855 |
# File 'lib/aws-sdk-ssm/client.rb', line 1852 def create_ops_item(params = {}, = {}) req = build_request(:create_ops_item, params) req.send_request() end |
#create_ops_metadata(params = {}) ⇒ Types::CreateOpsMetadataResult
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
1908 1909 1910 1911 |
# File 'lib/aws-sdk-ssm/client.rb', line 1908 def (params = {}, = {}) req = build_request(:create_ops_metadata, params) req.send_request() end |
#create_patch_baseline(params = {}) ⇒ Types::CreatePatchBaselineResult
Creates a patch baseline.
<note markdown=“1”> For information about valid key-value pairs in ‘PatchFilters` for each supported operating system type, see PatchFilter.
</note>
2080 2081 2082 2083 |
# File 'lib/aws-sdk-ssm/client.rb', line 2080 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. Amazon Web Services 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 Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see [Configuring resource data sync for Inventory] in the *Amazon Web Services Systems Manager User Guide*.
You can configure Systems Manager Explorer to use the ‘SyncFromSource` type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or `EntireOrganization` by using Organizations. For more information, see [Setting up Systems Manager Explorer to display data from multiple accounts and Regions] in the *Amazon Web Services 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 isn’t 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
2181 2182 2183 2184 |
# File 'lib/aws-sdk-ssm/client.rb', line 2181 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 aren’t required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn’t de-register managed nodes. You must manually de-register managed nodes.
2206 2207 2208 2209 |
# File 'lib/aws-sdk-ssm/client.rb', line 2206 def delete_activation(params = {}, = {}) req = build_request(:delete_activation, params) req.send_request() end |
#delete_association(params = {}) ⇒ Struct
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the ‘Targets` parameter, then you must delete the association by using the association ID.
When you disassociate a document from a managed node, it doesn’t change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
2256 2257 2258 2259 |
# File 'lib/aws-sdk-ssm/client.rb', line 2256 def delete_association(params = {}, = {}) req = build_request(:delete_association, params) req.send_request() end |
#delete_document(params = {}) ⇒ Struct
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
2301 2302 2303 2304 |
# File 'lib/aws-sdk-ssm/client.rb', line 2301 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.
2371 2372 2373 2374 |
# File 'lib/aws-sdk-ssm/client.rb', line 2371 def delete_inventory(params = {}, = {}) req = build_request(:delete_inventory, params) req.send_request() end |
#delete_maintenance_window(params = {}) ⇒ Types::DeleteMaintenanceWindowResult
Deletes a maintenance window.
2399 2400 2401 2402 |
# File 'lib/aws-sdk-ssm/client.rb', line 2399 def delete_maintenance_window(params = {}, = {}) req = build_request(:delete_maintenance_window, params) req.send_request() end |
#delete_ops_item(params = {}) ⇒ Struct
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Note the following important information about this operation.
* Deleting an OpsItem is irreversible. You can't restore a deleted
OpsItem.
-
This operation uses an *eventual consistency model*, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.
-
This operation is idempotent. The system doesn’t throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.
-
This operation doesn’t support cross-account calls. A delegated administrator or management account can’t delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see [Setting up OpsCenter to centrally manage OpsItems across accounts] in the *Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setting-up-cross-account.html
2448 2449 2450 2451 |
# File 'lib/aws-sdk-ssm/client.rb', line 2448 def delete_ops_item(params = {}, = {}) req = build_request(:delete_ops_item, params) req.send_request() end |
#delete_ops_metadata(params = {}) ⇒ Struct
Delete OpsMetadata related to an application.
2470 2471 2472 2473 |
# File 'lib/aws-sdk-ssm/client.rb', line 2470 def (params = {}, = {}) req = build_request(:delete_ops_metadata, params) req.send_request() end |
#delete_parameter(params = {}) ⇒ Struct
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
2493 2494 2495 2496 |
# File 'lib/aws-sdk-ssm/client.rb', line 2493 def delete_parameter(params = {}, = {}) req = build_request(:delete_parameter, params) req.send_request() end |
#delete_parameters(params = {}) ⇒ Types::DeleteParametersResult
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
2527 2528 2529 2530 |
# File 'lib/aws-sdk-ssm/client.rb', line 2527 def delete_parameters(params = {}, = {}) req = build_request(:delete_parameters, params) req.send_request() end |
#delete_patch_baseline(params = {}) ⇒ Types::DeletePatchBaselineResult
Deletes a patch baseline.
2555 2556 2557 2558 |
# File 'lib/aws-sdk-ssm/client.rb', line 2555 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 nodes are no longer synced to or from the target. Deleting a sync configuration doesn’t delete data.
2583 2584 2585 2586 |
# File 'lib/aws-sdk-ssm/client.rb', line 2583 def delete_resource_data_sync(params = {}, = {}) req = build_request(:delete_resource_data_sync, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, ‘OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
2621 2622 2623 2624 |
# File 'lib/aws-sdk-ssm/client.rb', line 2621 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, 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 node again at any time. If you don’t plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
2647 2648 2649 2650 |
# File 'lib/aws-sdk-ssm/client.rb', line 2647 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.
2682 2683 2684 2685 |
# File 'lib/aws-sdk-ssm/client.rb', line 2682 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.
2722 2723 2724 2725 |
# File 'lib/aws-sdk-ssm/client.rb', line 2722 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.
2756 2757 2758 2759 |
# File 'lib/aws-sdk-ssm/client.rb', line 2756 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2819 2820 2821 2822 |
# File 'lib/aws-sdk-ssm/client.rb', line 2819 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 managed node. If you created the association by using the ‘Targets` parameter, then you must retrieve the association by using the association ID.
2923 2924 2925 2926 |
# File 'lib/aws-sdk-ssm/client.rb', line 2923 def describe_association(params = {}, = {}) req = build_request(:describe_association, params) req.send_request() end |
#describe_association_execution_targets(params = {}) ⇒ Types::DescribeAssociationExecutionTargetsResult
Views information about a specific execution of a specific association.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2998 2999 3000 3001 |
# File 'lib/aws-sdk-ssm/client.rb', line 2998 def describe_association_execution_targets(params = {}, = {}) req = build_request(:describe_association_execution_targets, params) req.send_request() end |
#describe_association_executions(params = {}) ⇒ Types::DescribeAssociationExecutionsResult
Views all executions for a specific association ID.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3073 3074 3075 3076 |
# File 'lib/aws-sdk-ssm/client.rb', line 3073 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3193 3194 3195 3196 |
# File 'lib/aws-sdk-ssm/client.rb', line 3193 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3305 3306 3307 3308 |
# File 'lib/aws-sdk-ssm/client.rb', line 3305 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3468 3469 3470 3471 |
# File 'lib/aws-sdk-ssm/client.rb', line 3468 def describe_available_patches(params = {}, = {}) req = build_request(:describe_available_patches, params) req.send_request() end |
#describe_document(params = {}) ⇒ Types::DescribeDocumentResult
Describes the specified Amazon Web Services Systems Manager document (SSM document).
3554 3555 3556 3557 |
# File 'lib/aws-sdk-ssm/client.rb', line 3554 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 Amazon Web Services Systems Manager document (SSM 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 Amazon Web Services account ID) or publicly (All).
3609 3610 3611 3612 |
# File 'lib/aws-sdk-ssm/client.rb', line 3609 def (params = {}, = {}) req = build_request(:describe_document_permission, params) req.send_request() end |
#describe_effective_instance_associations(params = {}) ⇒ Types::DescribeEffectiveInstanceAssociationsResult
All associations for the managed node(s).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3656 3657 3658 3659 |
# File 'lib/aws-sdk-ssm/client.rb', line 3656 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. Applies to patch baselines for Windows only.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3728 3729 3730 3731 |
# File 'lib/aws-sdk-ssm/client.rb', line 3728 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 managed node(s).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3784 3785 3786 3787 |
# File 'lib/aws-sdk-ssm/client.rb', line 3784 def describe_instance_associations_status(params = {}, = {}) req = build_request(:describe_instance_associations_status, params) req.send_request() end |
#describe_instance_information(params = {}) ⇒ Types::DescribeInstanceInformationResult
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don’t specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn’t valid or a node that you don’t own, you receive an error.
<note markdown=“1”> The ‘IamRole` field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3889 3890 3891 3892 |
# File 'lib/aws-sdk-ssm/client.rb', line 3889 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 managed nodes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3953 3954 3955 3956 |
# File 'lib/aws-sdk-ssm/client.rb', line 3953 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 managed nodes in the specified patch group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4034 4035 4036 4037 |
# File 'lib/aws-sdk-ssm/client.rb', line 4034 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 managed node and their state relative to the patch baseline being used for the node.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4121 4122 4123 4124 |
# File 'lib/aws-sdk-ssm/client.rb', line 4121 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4177 4178 4179 4180 |
# File 'lib/aws-sdk-ssm/client.rb', line 4177 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4250 4251 4252 4253 |
# File 'lib/aws-sdk-ssm/client.rb', line 4250 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4321 4322 4323 4324 |
# File 'lib/aws-sdk-ssm/client.rb', line 4321 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4389 4390 4391 4392 |
# File 'lib/aws-sdk-ssm/client.rb', line 4389 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4461 4462 4463 4464 |
# File 'lib/aws-sdk-ssm/client.rb', line 4461 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4525 4526 4527 4528 |
# File 'lib/aws-sdk-ssm/client.rb', line 4525 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.
<note markdown=“1”> For maintenance window tasks without a specified target, you can’t supply values for ‘–max-errors` and `–max-concurrency`. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. These values don’t affect the running of your task and can be ignored.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4611 4612 4613 4614 |
# File 'lib/aws-sdk-ssm/client.rb', line 4611 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 Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4673 4674 4675 4676 |
# File 'lib/aws-sdk-ssm/client.rb', line 4673 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 a managed node is associated with.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4729 4730 4731 4732 |
# File 'lib/aws-sdk-ssm/client.rb', line 4729 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 Identity and Access Management (IAM) to query a list of OpsItems. For more information, see [Set up OpsCenter] in the *Amazon Web Services Systems Manager User Guide*.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see
- OpsCenter][2
-
in the *Amazon Web Services Systems Manager User
Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4876 4877 4878 4879 |
# File 'lib/aws-sdk-ssm/client.rb', line 4876 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.
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.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, ‘DescribeParameters` retrieves whatever the original key alias was referencing.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4962 4963 4964 4965 |
# File 'lib/aws-sdk-ssm/client.rb', line 4962 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 Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5027 5028 5029 5030 |
# File 'lib/aws-sdk-ssm/client.rb', line 5027 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 information for a patch group.
5078 5079 5080 5081 |
# File 'lib/aws-sdk-ssm/client.rb', line 5078 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5140 5141 5142 5143 |
# File 'lib/aws-sdk-ssm/client.rb', line 5140 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 operations 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:
AMAZON_LINUX
: Valid properties: ‘PRODUCT` | `CLASSIFICATION` | `SEVERITY`
AMAZON_LINUX_2
: Valid properties: ‘PRODUCT` | `CLASSIFICATION` | `SEVERITY`
CENTOS
: Valid properties: ‘PRODUCT` | `CLASSIFICATION` | `SEVERITY`
DEBIAN
: Valid properties: ‘PRODUCT` | `PRIORITY`
MACOS
: Valid properties: ‘PRODUCT` | `CLASSIFICATION`
ORACLE_LINUX
: Valid properties: ‘PRODUCT` | `CLASSIFICATION` | `SEVERITY`
REDHAT_ENTERPRISE_LINUX
: Valid properties: ‘PRODUCT` | `CLASSIFICATION` | `SEVERITY`
SUSE
: Valid properties: ‘PRODUCT` | `CLASSIFICATION` | `SEVERITY`
UBUNTU
: Valid properties: ‘PRODUCT` | `PRIORITY`
WINDOWS
: Valid properties: ‘PRODUCT` | `PRODUCT_FAMILY` | `CLASSIFICATION`
\| `MSRC_SEVERITY`
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5244 5245 5246 5247 |
# File 'lib/aws-sdk-ssm/client.rb', line 5244 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5311 5312 5313 5314 |
# File 'lib/aws-sdk-ssm/client.rb', line 5311 def describe_sessions(params = {}, = {}) req = build_request(:describe_sessions, params) req.send_request() end |
#disassociate_ops_item_related_item(params = {}) ⇒ Struct
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
5342 5343 5344 5345 |
# File 'lib/aws-sdk-ssm/client.rb', line 5342 def (params = {}, = {}) req = build_request(:disassociate_ops_item_related_item, params) req.send_request() end |
#get_automation_execution(params = {}) ⇒ Types::GetAutomationExecutionResult
Get detailed information about a particular Automation execution.
5516 5517 5518 5519 |
# File 'lib/aws-sdk-ssm/client.rb', line 5516 def get_automation_execution(params = {}, = {}) req = build_request(:get_automation_execution, params) req.send_request() end |
#get_calendar_state(params = {}) ⇒ Types::GetCalendarStateResponse
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, ‘GetCalendarState` returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don’t specify a time, ‘GetCalendarState` uses the current time. Change Calendar entries have two possible states: `OPEN` or `CLOSED`.
If you specify more than one calendar in a request, the command returns the status of ‘OPEN` only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is `CLOSED`.
For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see [Amazon Web Services Systems Manager Change Calendar] in the *Amazon Web Services Systems Manager User Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html
5580 5581 5582 5583 |
# File 'lib/aws-sdk-ssm/client.rb', line 5580 def get_calendar_state(params = {}, = {}) req = build_request(:get_calendar_state, params) req.send_request() end |
#get_command_invocation(params = {}) ⇒ Types::GetCommandInvocationResult
Returns detailed information about command execution for an invocation or plugin.
‘GetCommandInvocation` only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.
The following waiters are defined for this operation (see #wait_until for detailed usage):
* command_executed
5675 5676 5677 5678 |
# File 'lib/aws-sdk-ssm/client.rb', line 5675 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 a managed node to determine whether it is running and ready to receive Session Manager connections.
5707 5708 5709 5710 |
# File 'lib/aws-sdk-ssm/client.rb', line 5707 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. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don’t specify an operating system value, the default patch baseline for Windows is returned.
5743 5744 5745 5746 |
# File 'lib/aws-sdk-ssm/client.rb', line 5743 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 managed node uses. This API is primarily used by the ‘AWS-RunPatchBaseline` Systems Manager document (SSM document).
<note markdown=“1”> If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the ‘AWS-RunShellScript` document or the `AWS-RunPowerShellScript` document.
</note>
5841 5842 5843 5844 |
# File 'lib/aws-sdk-ssm/client.rb', line 5841 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 Amazon Web Services Systems Manager document (SSM document).
5918 5919 5920 5921 |
# File 'lib/aws-sdk-ssm/client.rb', line 5918 def get_document(params = {}, = {}) req = build_request(:get_document, params) req.send_request() end |
#get_inventory(params = {}) ⇒ Types::GetInventoryResult
Query inventory information. This includes managed node status, such as ‘Stopped` or `Terminated`.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6013 6014 6015 6016 |
# File 'lib/aws-sdk-ssm/client.rb', line 6013 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6074 6075 6076 6077 |
# File 'lib/aws-sdk-ssm/client.rb', line 6074 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.
6131 6132 6133 6134 |
# File 'lib/aws-sdk-ssm/client.rb', line 6131 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.
6170 6171 6172 6173 |
# File 'lib/aws-sdk-ssm/client.rb', line 6170 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.
6239 6240 6241 6242 |
# File 'lib/aws-sdk-ssm/client.rb', line 6239 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.
6300 6301 6302 6303 |
# File 'lib/aws-sdk-ssm/client.rb', line 6300 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
Retrieves the details of a maintenance window task.
<note markdown=“1”> For maintenance window tasks without a specified target, you can’t supply values for ‘–max-errors` and `–max-concurrency`. Instead, the system inserts a placeholder value of `1`, which may be reported in the response to this command. These values don’t affect the running of your task and can be ignored.
</note>
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
6407 6408 6409 6410 |
# File 'lib/aws-sdk-ssm/client.rb', line 6407 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 Identity and Access Management (IAM) to view information about an OpsItem. For more information, see [Set up OpsCenter] in the *Amazon Web Services Systems Manager User Guide*.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see
- OpsCenter][2
-
in the *Amazon Web Services Systems Manager User
Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
6479 6480 6481 6482 |
# File 'lib/aws-sdk-ssm/client.rb', line 6479 def get_ops_item(params = {}, = {}) req = build_request(:get_ops_item, params) req.send_request() end |
#get_ops_metadata(params = {}) ⇒ Types::GetOpsMetadataResult
View operational metadata related to an application in Application Manager.
6524 6525 6526 6527 |
# File 'lib/aws-sdk-ssm/client.rb', line 6524 def (params = {}, = {}) req = build_request(:get_ops_metadata, params) req.send_request() end |
#get_ops_summary(params = {}) ⇒ Types::GetOpsSummaryResult
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6620 6621 6622 6623 |
# File 'lib/aws-sdk-ssm/client.rb', line 6620 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 single parameter by specifying the parameter name.
<note markdown=“1”> To get information about more than one parameter at a time, use the GetParameters operation.
</note>
6670 6671 6672 6673 |
# File 'lib/aws-sdk-ssm/client.rb', line 6670 def get_parameter(params = {}, = {}) req = build_request(:get_parameter, params) req.send_request() end |
#get_parameter_history(params = {}) ⇒ Types::GetParameterHistoryResult
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, ‘GetParameterHistory` retrieves whatever the original key alias was referencing.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6740 6741 6742 6743 |
# File 'lib/aws-sdk-ssm/client.rb', line 6740 def get_parameter_history(params = {}, = {}) req = build_request(:get_parameter_history, params) req.send_request() end |
#get_parameters(params = {}) ⇒ Types::GetParametersResult
Get information about one or more parameters by specifying multiple parameter names.
<note markdown=“1”> To get information about a single parameter, you can use the GetParameter operation instead.
</note>
6795 6796 6797 6798 |
# File 'lib/aws-sdk-ssm/client.rb', line 6795 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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6895 6896 6897 6898 |
# File 'lib/aws-sdk-ssm/client.rb', line 6895 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.
6978 6979 6980 6981 |
# File 'lib/aws-sdk-ssm/client.rb', line 6978 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.
7016 7017 7018 7019 |
# File 'lib/aws-sdk-ssm/client.rb', line 7016 def get_patch_baseline_for_patch_group(params = {}, = {}) req = build_request(:get_patch_baseline_for_patch_group, params) req.send_request() end |
#get_resource_policies(params = {}) ⇒ Types::GetResourcePoliciesResponse
Returns an array of the ‘Policy` object.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7063 7064 7065 7066 |
# File 'lib/aws-sdk-ssm/client.rb', line 7063 def get_resource_policies(params = {}, = {}) req = build_request(:get_resource_policies, params) req.send_request() end |
#get_service_setting(params = {}) ⇒ Types::GetServiceSettingResult
‘ServiceSetting` is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.
Query the current service setting for the Amazon Web Services account.
7131 7132 7133 7134 |
# File 'lib/aws-sdk-ssm/client.rb', line 7131 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, Amazon Web Services 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.
-
If you no longer want to use a parameter label, then you can either delete it or 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 isn’t associated with a parameter and the system displays it in the list of InvalidLabels.
7202 7203 7204 7205 |
# File 'lib/aws-sdk-ssm/client.rb', line 7202 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7286 7287 7288 7289 |
# File 'lib/aws-sdk-ssm/client.rb', line 7286 def list_association_versions(params = {}, = {}) req = build_request(:list_association_versions, params) req.send_request() end |
#list_associations(params = {}) ⇒ Types::ListAssociationsResult
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7367 7368 7369 7370 |
# File 'lib/aws-sdk-ssm/client.rb', line 7367 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 managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs ‘SendCommand` against three managed nodes, then a command invocation is created for each requested managed node ID. `ListCommandInvocations` provide status about command execution.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7467 7468 7469 7470 |
# File 'lib/aws-sdk-ssm/client.rb', line 7467 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 Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7571 7572 7573 7574 |
# File 'lib/aws-sdk-ssm/client.rb', line 7571 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 operation 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7646 7647 7648 7649 |
# File 'lib/aws-sdk-ssm/client.rb', line 7646 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7714 7715 7716 7717 |
# File 'lib/aws-sdk-ssm/client.rb', line 7714 def list_compliance_summaries(params = {}, = {}) req = build_request(:list_compliance_summaries, params) req.send_request() end |
#list_document_metadata_history(params = {}) ⇒ Types::ListDocumentMetadataHistoryResponse
Information about approval reviews for a version of a change template in Change Manager.
7778 7779 7780 7781 |
# File 'lib/aws-sdk-ssm/client.rb', line 7778 def (params = {}, = {}) req = build_request(:list_document_metadata_history, params) req.send_request() end |
#list_document_versions(params = {}) ⇒ Types::ListDocumentVersionsResult
List all versions for a document.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7832 7833 7834 7835 |
# File 'lib/aws-sdk-ssm/client.rb', line 7832 def list_document_versions(params = {}, = {}) req = build_request(:list_document_versions, params) req.send_request() end |
#list_documents(params = {}) ⇒ Types::ListDocumentsResult
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7925 7926 7927 7928 |
# File 'lib/aws-sdk-ssm/client.rb', line 7925 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.
7991 7992 7993 7994 |
# File 'lib/aws-sdk-ssm/client.rb', line 7991 def list_inventory_entries(params = {}, = {}) req = build_request(:list_inventory_entries, params) req.send_request() end |
#list_ops_item_events(params = {}) ⇒ Types::ListOpsItemEventsResponse
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8051 8052 8053 8054 |
# File 'lib/aws-sdk-ssm/client.rb', line 8051 def list_ops_item_events(params = {}, = {}) req = build_request(:list_ops_item_events, params) req.send_request() end |
#list_ops_item_related_items(params = {}) ⇒ Types::ListOpsItemRelatedItemsResponse
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8117 8118 8119 8120 |
# File 'lib/aws-sdk-ssm/client.rb', line 8117 def (params = {}, = {}) req = build_request(:list_ops_item_related_items, params) req.send_request() end |
#list_ops_metadata(params = {}) ⇒ Types::ListOpsMetadataResult
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8172 8173 8174 8175 |
# File 'lib/aws-sdk-ssm/client.rb', line 8172 def (params = {}, = {}) req = build_request(:list_ops_metadata, 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8247 8248 8249 8250 |
# File 'lib/aws-sdk-ssm/client.rb', line 8247 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8327 8328 8329 8330 |
# File 'lib/aws-sdk-ssm/client.rb', line 8327 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.
For information about the ID format for each supported resource type, see AddTagsToResource.
8364 8365 8366 8367 |
# File 'lib/aws-sdk-ssm/client.rb', line 8364 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#modify_document_permission(params = {}) ⇒ Struct
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
8413 8414 8415 8416 |
# File 'lib/aws-sdk-ssm/client.rb', line 8413 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 operation 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 managed node.
-
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: An 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’
8539 8540 8541 8542 |
# File 'lib/aws-sdk-ssm/client.rb', line 8539 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 or more managed nodes. The request adds an inventory item, if it doesn’t already exist, or updates an inventory item, if it does exist.
8588 8589 8590 8591 |
# File 'lib/aws-sdk-ssm/client.rb', line 8588 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.
8894 8895 8896 8897 |
# File 'lib/aws-sdk-ssm/client.rb', line 8894 def put_parameter(params = {}, = {}) req = build_request(:put_parameter, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. Currently, ‘OpsItemGroup` is the only resource that supports Systems Manager resource policies. The resource policy for `OpsItemGroup` enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).
8945 8946 8947 8948 |
# File 'lib/aws-sdk-ssm/client.rb', line 8945 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, 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 Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (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`.
8980 8981 8982 8983 |
# File 'lib/aws-sdk-ssm/client.rb', line 8980 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.
9014 9015 9016 9017 |
# File 'lib/aws-sdk-ssm/client.rb', line 9014 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.
9124 9125 9126 9127 |
# File 'lib/aws-sdk-ssm/client.rb', line 9124 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.
9386 9387 9388 9389 |
# File 'lib/aws-sdk-ssm/client.rb', line 9386 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.
9447 9448 9449 9450 |
# File 'lib/aws-sdk-ssm/client.rb', line 9447 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 Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.
Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
9515 9516 9517 9518 |
# File 'lib/aws-sdk-ssm/client.rb', line 9515 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 a managed node 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 isn’t intended for any other use.
</note>
9555 9556 9557 9558 |
# File 'lib/aws-sdk-ssm/client.rb', line 9555 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.
9605 9606 9607 9608 |
# File 'lib/aws-sdk-ssm/client.rb', line 9605 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 nodes.
9866 9867 9868 9869 |
# File 'lib/aws-sdk-ssm/client.rb', line 9866 def send_command(params = {}, = {}) req = build_request(:send_command, params) req.send_request() end |
#start_associations_once(params = {}) ⇒ Struct
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
9890 9891 9892 9893 |
# File 'lib/aws-sdk-ssm/client.rb', line 9890 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 runbook.
10060 10061 10062 10063 |
# File 'lib/aws-sdk-ssm/client.rb', line 10060 def start_automation_execution(params = {}, = {}) req = build_request(:start_automation_execution, params) req.send_request() end |
#start_change_request_execution(params = {}) ⇒ Types::StartChangeRequestExecutionResult
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
10221 10222 10223 10224 |
# File 'lib/aws-sdk-ssm/client.rb', line 10221 def start_change_request_execution(params = {}, = {}) req = build_request(:start_change_request_execution, params) req.send_request() end |
#start_session(params = {}) ⇒ Types::StartSessionResponse
Initiates a connection to a target (for example, a managed node) 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”> Amazon Web Services 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 Amazon Web Services CLI] in the *Amazon Web Services Systems Manager User Guide*.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession
isn’t currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
</note>
10298 10299 10300 10301 |
# File 'lib/aws-sdk-ssm/client.rb', line 10298 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.
10325 10326 10327 10328 |
# File 'lib/aws-sdk-ssm/client.rb', line 10325 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 managed node. A terminated session can’t be resumed.
10355 10356 10357 10358 |
# File 'lib/aws-sdk-ssm/client.rb', line 10355 def terminate_session(params = {}, = {}) req = build_request(:terminate_session, params) req.send_request() end |
#unlabel_parameter_version(params = {}) ⇒ Types::UnlabelParameterVersionResult
Remove a label or labels from a parameter.
10397 10398 10399 10400 |
# File 'lib/aws-sdk-ssm/client.rb', line 10397 def unlabel_parameter_version(params = {}, = {}) req = build_request(:unlabel_parameter_version, 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 Simple Storage Service (Amazon S3) output. When you call ‘UpdateAssociation`, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the `Name` parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your `UpdateAssociation` call.
In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. 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> isn’t authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>‘
When you update an association, the association immediately runs against the specified targets. You can add the ‘ApplyOnlyAtCronInterval` parameter to run the association during the next schedule run.
10743 10744 10745 10746 |
# File 'lib/aws-sdk-ssm/client.rb', line 10743 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 Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
‘UpdateAssociationStatus` is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the `InstanceId` legacy parameter.
10848 10849 10850 10851 |
# File 'lib/aws-sdk-ssm/client.rb', line 10848 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.
10973 10974 10975 10976 |
# File 'lib/aws-sdk-ssm/client.rb', line 10973 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.
<note markdown=“1”> If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the ‘apply-only-at-cron-interval` parameter.
</note>
11015 11016 11017 11018 |
# File 'lib/aws-sdk-ssm/client.rb', line 11015 def update_document_default_version(params = {}, = {}) req = build_request(:update_document_default_version, params) req.send_request() end |
#update_document_metadata(params = {}) ⇒ Struct
Updates information related to approval reviews for a specific version of a change template in Change Manager.
11055 11056 11057 11058 |
# File 'lib/aws-sdk-ssm/client.rb', line 11055 def (params = {}, = {}) req = build_request(:update_document_metadata, 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>
11191 11192 11193 11194 |
# File 'lib/aws-sdk-ssm/client.rb', line 11191 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 isn’t modified.
</note>
11285 11286 11287 11288 |
# File 'lib/aws-sdk-ssm/client.rb', line 11285 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`
<note markdown=“1”> One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don’t specify targets, see [Registering maintenance window tasks without targets] in the *Amazon Web Services Systems Manager User Guide*.
</note>
If the value for a parameter in ‘UpdateMaintenanceWindowTask` is null, then the corresponding field isn’t modified. If you set ‘Replace` to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren’t specified are set to null.
When you update a maintenance window task that has options specified in ‘TaskInvocationParameters`, you must provide again all the `TaskInvocationParameters` values that you want to retain. The values you don’t specify again are removed. For example, suppose that when you registered a Run Command task, you specified ‘TaskInvocationParameters` values for `Comment`, `NotificationConfig`, and `OutputS3BucketName`. If you update the maintenance window task and specify only a different `OutputS3BucketName` value, the values for `Comment` and `NotificationConfig` are removed.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/maintenance-windows-targetless-tasks.html
11663 11664 11665 11666 |
# File 'lib/aws-sdk-ssm/client.rb', line 11663 def update_maintenance_window_task(params = {}, = {}) req = build_request(:update_maintenance_window_task, params) req.send_request() end |
#update_managed_instance_role(params = {}) ⇒ Struct
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.
11706 11707 11708 11709 |
# File 'lib/aws-sdk-ssm/client.rb', line 11706 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 Identity and Access Management (IAM) to update an OpsItem. For more information, see [Set up OpsCenter] in the *Amazon Web Services Systems Manager User Guide*.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see
- OpsCenter][2
-
in the *Amazon Web Services Systems Manager User
Guide*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-setup.html [2]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html
11863 11864 11865 11866 |
# File 'lib/aws-sdk-ssm/client.rb', line 11863 def update_ops_item(params = {}, = {}) req = build_request(:update_ops_item, params) req.send_request() end |
#update_ops_metadata(params = {}) ⇒ Types::UpdateOpsMetadataResult
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
11904 11905 11906 11907 |
# File 'lib/aws-sdk-ssm/client.rb', line 11904 def (params = {}, = {}) req = build_request(:update_ops_metadata, 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-value pairs in ‘PatchFilters` for each supported operating system type, see PatchFilter.
</note>
12093 12094 12095 12096 |
# File 'lib/aws-sdk-ssm/client.rb', line 12093 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 Organizations configuration` option. Instead, you must delete the first resource data sync, and create a new one.
<note markdown=“1”> This API operation only supports a resource data sync that was created with a SyncFromSource ‘SyncType`.
</note>
12148 12149 12150 12151 |
# File 'lib/aws-sdk-ssm/client.rb', line 12148 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 Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services 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. Amazon Web Services 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 operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.
Update the service setting for the account.
12242 12243 12244 12245 |
# File 'lib/aws-sdk-ssm/client.rb', line 12242 def update_service_setting(params = {}, = {}) req = build_request(:update_service_setting, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | —————- | ——————————- | ——– | ————- | | command_executed | #get_command_invocation | 5 | 20 |
12352 12353 12354 12355 12356 |
# File 'lib/aws-sdk-ssm/client.rb', line 12352 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) 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.
12360 12361 12362 |
# File 'lib/aws-sdk-ssm/client.rb', line 12360 def waiter_names waiters.keys end |