Class: Aws::SSM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SSM::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-ssm/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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_cloud_connector(params = {}) ⇒ Types::CreateCloudConnectorResult
Creates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment.
-
#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_cloud_connector(params = {}) ⇒ Types::DeleteCloudConnectorResult
Deletes a cloud connector.
-
#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_default_host_management_configuration(params = {}) ⇒ Struct
Removes the Default Host Management Configuration (DHMC) for an Amazon Web Services account and Amazon Web Services Region.
-
#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 nodes.
-
#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 nodes.
-
#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_instance_properties(params = {}) ⇒ Types::DescribeInstancePropertiesResult
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
-
#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
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the [Shared][1] option.
-
#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_access_token(params = {}) ⇒ Types::GetAccessTokenResponse
Returns a credentials set to be used with just-in-time node access.
-
#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_cloud_connector(params = {}) ⇒ Types::GetCloudConnectorResult
Returns detailed information about a cloud connector.
-
#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_execution_preview(params = {}) ⇒ Types::GetExecutionPreviewResponse
Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.
-
#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 under a specified level in a 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
Policyobject. -
#get_service_setting(params = {}) ⇒ Types::GetServiceSettingResult
ServiceSettingis 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_cloud_connectors(params = {}) ⇒ Types::ListCloudConnectorsResult
Returns a list of cloud connectors 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
Amazon Web Services Systems Manager Change Manager is no longer open to new customers.
-
#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_nodes(params = {}) ⇒ Types::ListNodesResult
Takes in filters and returns a list of managed nodes matching the filter criteria.
-
#list_nodes_summary(params = {}) ⇒ Types::ListNodesSummaryResult
Generates a summary of managed instance/node metadata based on the filters and aggregators you specify.
-
#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
Create or update a parameter in Parameter Store.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Creates or updates a Systems Manager resource policy.
-
#register_default_host_management_configuration(params = {}) ⇒ Types::RegisterDefaultHostManagementConfigurationResult
Enables Default Host Management Configuration (DHMC) for the current Amazon Web Services account and Amazon Web Services Region.
-
#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
ServiceSettingis 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_access_request(params = {}) ⇒ Types::StartAccessRequestResponse
Starts the workflow for just-in-time node access sessions.
-
#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
Amazon Web Services Systems Manager Change Manager is no longer open to new customers.
-
#start_execution_preview(params = {}) ⇒ Types::StartExecutionPreviewResponse
Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.
-
#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_cloud_connector(params = {}) ⇒ Types::UpdateCloudConnectorResult
Updates an existing cloud connector with new configuration details.
-
#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
Amazon Web Services Systems Manager Change Manager is no longer open to new customers.
-
#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
ServiceSettingis an account-level setting for an Amazon Web Services service. -
#validate_cloud_connector(params = {}) ⇒ Types::ValidateCloudConnectorResult
Validates the configuration and connectivity of a cloud connector.
Instance Method Summary collapse
-
#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.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 486 def initialize(*args) super 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=DbAdminKey=Owner,Value=SysAdminKey=Owner,Value=DevKey=Stack,Value=ProductionKey=Stack,Value=Pre-ProductionKey=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 Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
596 597 598 599 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 596 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 tools in Amazon Web Services Systems Manager.
648 649 650 651 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 648 def (params = {}, = {}) req = build_request(:associate_ops_item_related_item, params) req.send_request() 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.
678 679 680 681 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 678 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.
708 709 710 711 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 708 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 tools. 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 Using Amazon Web Services Systems Manager in hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.
840 841 842 843 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 840 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 tool in 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.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1265 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1523 def create_association_batch(params = {}, = {}) req = build_request(:create_association_batch, params) req.send_request() end |
#create_cloud_connector(params = {}) ⇒ Types::CreateCloudConnectorResult
Creates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment.
1611 1612 1613 1614 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1611 def create_cloud_connector(params = {}, = {}) req = build_request(:create_cloud_connector, 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.
1828 1829 1830 1831 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1828 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.
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.
1972 1973 1974 1975 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1972 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 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.
2184 2185 2186 2187 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2184 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.
2240 2241 2242 2243 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2240 def (params = {}, = {}) req = build_request(:create_ops_metadata, params) req.send_request() end |
#create_patch_baseline(params = {}) ⇒ Types::CreatePatchBaselineResult
Creates a patch baseline.
PatchFilters for each
supported operating system type, see PatchFilter.
2451 2452 2453 2454 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2451 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 Creating a 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.
2552 2553 2554 2555 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2552 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.
2577 2578 2579 2580 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2577 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.
2627 2628 2629 2630 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2627 def delete_association(params = {}, = {}) req = build_request(:delete_association, params) req.send_request() end |
#delete_cloud_connector(params = {}) ⇒ Types::DeleteCloudConnectorResult
Deletes a cloud connector.
2655 2656 2657 2658 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2655 def delete_cloud_connector(params = {}, = {}) req = build_request(:delete_cloud_connector, 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.
2700 2701 2702 2703 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2700 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.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2770 def delete_inventory(params = {}, = {}) req = build_request(:delete_inventory, params) req.send_request() end |
#delete_maintenance_window(params = {}) ⇒ Types::DeleteMaintenanceWindowResult
Deletes a maintenance window.
2798 2799 2800 2801 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2798 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.
2847 2848 2849 2850 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2847 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.
2869 2870 2871 2872 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2869 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.
ssm:DeleteParameter action.
Denying that action alone doesn't restrict DeleteParameters, which is
authorized against its own action. For more information, see
Restricting access to specific parameters and paths in the
Amazon Web Services Systems Manager User Guide.
2909 2910 2911 2912 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2909 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.
This operation is authorized against the ssm:DeleteParameters
action, not against ssm:DeleteParameter. Denying
ssm:DeleteParameter for a parameter doesn't prevent a principal
from deleting that parameter with this operation. For more
information, see Restricting access to specific parameters and
paths in the Amazon Web Services Systems Manager User Guide.
2959 2960 2961 2962 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2959 def delete_parameters(params = {}, = {}) req = build_request(:delete_parameters, params) req.send_request() end |
#delete_patch_baseline(params = {}) ⇒ Types::DeletePatchBaselineResult
Deletes a patch baseline.
2987 2988 2989 2990 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2987 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.
3015 3016 3017 3018 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3015 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. The following resources support Systems Manager resource policies.
OpsItemGroup- The resource policy forOpsItemGroupenables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).Parameter- The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.Document– Shares the document using Resource Access Manager (RAM). For more information about sharing documents, see Sharing Systems Manager documents in the Amazon Web Services Systems Manager User Guide.
3082 3083 3084 3085 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3082 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#deregister_default_host_management_configuration(params = {}) ⇒ Struct
Removes the Default Host Management Configuration (DHMC) for an Amazon Web Services account and Amazon Web Services Region. After you deregister DHMC, Amazon EC2 instances are no longer automatically managed as managed nodes by Amazon Web Services Systems Manager.
To use this operation, you must have the following permissions:
- You need the
ssm:GetServiceSettingandssm:ResetServiceSettingpermissions for the/ssm/managed-instance/default-ec2-instance-management-roleservice setting.
^
If the registered role is service-managed, you also need the
iam:DeleteRole permission so that Amazon Web Services Systems
Manager can remove the role it created.
3111 3112 3113 3114 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3111 def deregister_default_host_management_configuration(params = {}, = {}) req = build_request(:deregister_default_host_management_configuration, params) req.send_request() end |
#deregister_managed_instance(params = {}) ⇒ Struct
Removes the server or virtual machine from the list of registered servers.
If you want to reregister an on-premises server, edge device, or VM, you must use a different Activation Code and Activation ID than used to register the machine previously. The Activation Code and Activation ID must not have already been used on the maximum number of activations specified when they were created. For more information, see Deregistering managed nodes in a hybrid and multicloud environment in the Amazon Web Services Systems Manager User Guide.
3148 3149 3150 3151 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3148 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.
3183 3184 3185 3186 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3183 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.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3223 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.
3257 3258 3259 3260 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3257 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.
3320 3321 3322 3323 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3320 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.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3435 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.
3510 3511 3512 3513 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3510 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.
3585 3586 3587 3588 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3585 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.
3716 3717 3718 3719 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3716 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.
3838 3839 3840 3841 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3838 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.
DescribeAvailablePatches supports only the Amazon Linux
1, Amazon Linux 2, and Windows Server operating systems.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4006 4007 4008 4009 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4006 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).
4098 4099 4100 4101 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4098 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).
4153 4154 4155 4156 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4153 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 nodes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4200 4201 4202 4203 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4200 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.
4272 4273 4274 4275 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4272 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 nodes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4328 4329 4330 4331 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4328 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.
IamRole field returned for this API operation is the role
assigned to an Amazon EC2 instance configured with a Systems Manager
Quick Setup host management configuration or the role assigned to an
on-premises managed node.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4435 4436 4437 4438 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4435 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.
4500 4501 4502 4503 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4500 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.
4582 4583 4584 4585 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4582 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.
4668 4669 4670 4671 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4668 def describe_instance_patches(params = {}, = {}) req = build_request(:describe_instance_patches, params) req.send_request() end |
#describe_instance_properties(params = {}) ⇒ Types::DescribeInstancePropertiesResult
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4757 4758 4759 4760 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4757 def describe_instance_properties(params = {}, = {}) req = build_request(:describe_instance_properties, 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.
4813 4814 4815 4816 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4813 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.
4886 4887 4888 4889 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4886 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.
4957 4958 4959 4960 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4957 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.
5025 5026 5027 5028 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5025 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.
5097 5098 5099 5100 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5097 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.
5161 5162 5163 5164 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5161 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.
--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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5247 5248 5249 5250 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5247 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.
5309 5310 5311 5312 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5309 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.
5365 5366 5367 5368 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5365 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 Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5512 5513 5514 5515 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5512 def describe_ops_items(params = {}, = {}) req = build_request(:describe_ops_items, params) req.send_request() end |
#describe_parameters(params = {}) ⇒ Types::DescribeParametersResult
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
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.
Parameter names can't contain spaces. The service removes any spaces
specified for the beginning or end of a parameter name. If the
specified name for a parameter contains spaces between characters, the
request fails with a ValidationException error.
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.
5632 5633 5634 5635 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5632 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.
5697 5698 5699 5700 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5697 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.
5750 5751 5752 5753 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5750 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.
5812 5813 5814 5815 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5812 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- AMAZON_LINUX_2023
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.
5920 5921 5922 5923 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5920 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.
5988 5989 5990 5991 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5988 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 tool in Amazon Web Services Systems Manager.
6019 6020 6021 6022 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6019 def (params = {}, = {}) req = build_request(:disassociate_ops_item_related_item, params) req.send_request() end |
#get_access_token(params = {}) ⇒ Types::GetAccessTokenResponse
Returns a credentials set to be used with just-in-time node access.
6052 6053 6054 6055 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6052 def get_access_token(params = {}, = {}) req = build_request(:get_access_token, params) req.send_request() end |
#get_automation_execution(params = {}) ⇒ Types::GetAutomationExecutionResult
Get detailed information about a particular Automation execution.
6261 6262 6263 6264 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6261 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 tool in Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
6325 6326 6327 6328 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6325 def get_calendar_state(params = {}, = {}) req = build_request(:get_calendar_state, params) req.send_request() end |
#get_cloud_connector(params = {}) ⇒ Types::GetCloudConnectorResult
Returns detailed information about a cloud connector.
6379 6380 6381 6382 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6379 def get_cloud_connector(params = {}, = {}) req = build_request(:get_cloud_connector, params) req.send_request() end |
#get_command_invocation(params = {}) ⇒ Types::GetCommandInvocationResult
Returns detailed information about command execution for an invocation or plugin. The Run Command API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.
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
6479 6480 6481 6482 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6479 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.
6511 6512 6513 6514 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6511 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.
6547 6548 6549 6550 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6547 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).
AWS-RunShellScript document or the AWS-RunPowerShellScript
document.
6654 6655 6656 6657 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6654 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).
6731 6732 6733 6734 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6731 def get_document(params = {}, = {}) req = build_request(:get_document, params) req.send_request() end |
#get_execution_preview(params = {}) ⇒ Types::GetExecutionPreviewResponse
Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.
6803 6804 6805 6806 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6803 def get_execution_preview(params = {}, = {}) req = build_request(:get_execution_preview, 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.
6898 6899 6900 6901 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6898 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.
6959 6960 6961 6962 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 6959 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.
7016 7017 7018 7019 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7016 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.
7055 7056 7057 7058 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7055 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.
7124 7125 7126 7127 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7124 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.
7185 7186 7187 7188 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7185 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.
--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.
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
7292 7293 7294 7295 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7292 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 Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
7364 7365 7366 7367 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7364 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.
7409 7410 7411 7412 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7409 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.
7505 7506 7507 7508 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7505 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.
Parameter names can't contain spaces. The service removes any spaces
specified for the beginning or end of a parameter name. If the
specified name for a parameter contains spaces between characters, the
request fails with a ValidationException error.
ssm:GetParameter action.
Denying that action alone doesn't restrict GetParameters,
GetParameterHistory, or GetParametersByPath, each of which is
authorized against its own action. For more information, see How
Parameter Store authorizes parameter retrieval in the Amazon Web
Services Systems Manager User Guide.
GetParameter, GetParameters, and PutParameter API calls for your
Amazon Web Services account and Amazon Web Services Region. By
default, Parameter Store is configured with a standard throughput
quota suitable for low- to moderate-volume workloads. Applications
that retrieve configuration data infrequently or operate at smaller
scale can use this default setting without additional cost.
For higher-volume workloads, you can enable higher throughput. This
increases the maximum number of supported transactions per second for
your account and Region. Increased throughput supports applications
and workloads that need concurrent access to multiple parameters. If
you experience ThrottlingException: Rate exceeded errors, enable
higher throughput. For more information, see Changing Parameter Store
throughput.
7603 7604 7605 7606 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7603 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.
Parameter names can't contain spaces. The service removes any spaces
specified for the beginning or end of a parameter name. If the
specified name for a parameter contains spaces between characters, the
request fails with a ValidationException error.
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.
This operation is authorized against the ssm:GetParameterHistory
action, not against ssm:GetParameter. Because parameter history
includes every version of a parameter, including the current one, a
principal who is denied ssm:GetParameter, ssm:GetParameters, and
ssm:GetParametersByPath but allowed ssm:GetParameterHistory can
still read the current value. To restrict access to a parameter value,
deny every action that can return it. For more information, see How
Parameter Store authorizes parameter retrieval in the Amazon Web
Services Systems Manager User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7694 7695 7696 7697 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7694 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.
This operation is authorized against the ssm:GetParameters action,
not against ssm:GetParameter. Denying ssm:GetParameter for a
parameter doesn't prevent a principal from retrieving that parameter
with this operation. To restrict access to a parameter value, deny
every action that can return it. For more information, see How
Parameter Store authorizes parameter retrieval in the Amazon Web
Services Systems Manager User Guide.
Parameter names can't contain spaces. The service removes any spaces
specified for the beginning or end of a parameter name. If the
specified name for a parameter contains spaces between characters, the
request fails with a ValidationException error.
GetParameter, GetParameters, and PutParameter API calls for your
Amazon Web Services account and Amazon Web Services Region. By
default, Parameter Store is configured with a standard throughput
quota suitable for low- to moderate-volume workloads. Applications
that retrieve configuration data infrequently or operate at smaller
scale can use this default setting without additional cost.
For higher-volume workloads, you can enable higher throughput. This
increases the maximum number of supported transactions per second for
your account and Region. Increased throughput supports applications
and workloads that need concurrent access to multiple parameters. If
you experience ThrottlingException: Rate exceeded errors, enable
higher throughput. For more information, see Changing Parameter Store
throughput.
7801 7802 7803 7804 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7801 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 under a specified level in a hierarchy.
This operation is authorized against the ssm:GetParametersByPath
action for the path that you specify in the request. It isn't
authorized against the individual parameters that it returns, and it
isn't authorized against ssm:GetParameter. A principal who is
allowed to call this operation for the path /a with Recursive set
to true receives every parameter under that path, including /a/b,
even if a policy explicitly denies access to /a/b.
To prevent a parameter from being returned by this operation, deny
the
ssm:GetParametersByPath action on every ancestor path that could
include the parameter in its results. For more information, see
Restricting access to specific parameters and paths in the
Amazon Web Services Systems Manager User Guide.
Request results are returned on a best-effort basis. If you specify
MaxResults in the request, the response includes information up to
the limit specified. The number of items returned, however, can be
between zero and the value of MaxResults. If the service reaches an
internal limit while processing the results, it stops the operation
and returns the matching values up to that point and a NextToken.
You can specify the NextToken in a subsequent call to get the next
set of results.
Parameter names can't contain spaces. The service removes any spaces
specified for the beginning or end of a parameter name. If the
specified name for a parameter contains spaces between characters, the
request fails with a ValidationException error.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7918 7919 7920 7921 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 7918 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.
8003 8004 8005 8006 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8003 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.
8041 8042 8043 8044 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8041 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.
8088 8089 8090 8091 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8088 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.
8160 8161 8162 8163 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8160 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.Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a
ValidationExceptionerror.
8241 8242 8243 8244 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8241 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.
8336 8337 8338 8339 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8336 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 tool in Amazon Web Services Systems Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8418 8419 8420 8421 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8418 def list_associations(params = {}, = {}) req = build_request(:list_associations, params) req.send_request() end |
#list_cloud_connectors(params = {}) ⇒ Types::ListCloudConnectorsResult
Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
8474 8475 8476 8477 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8474 def list_cloud_connectors(params = {}, = {}) req = build_request(:list_cloud_connectors, 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.
8574 8575 8576 8577 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8574 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.
8678 8679 8680 8681 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8678 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.
8753 8754 8755 8756 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8753 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.
8821 8822 8823 8824 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8821 def list_compliance_summaries(params = {}, = {}) req = build_request(:list_compliance_summaries, params) req.send_request() end |
#list_document_metadata_history(params = {}) ⇒ Types::ListDocumentMetadataHistoryResponse
Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.
Information about approval reviews for a version of a change template in Change Manager.
8894 8895 8896 8897 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8894 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.
8948 8949 8950 8951 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 8948 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.
9041 9042 9043 9044 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9041 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.
9107 9108 9109 9110 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9107 def list_inventory_entries(params = {}, = {}) req = build_request(:list_inventory_entries, params) req.send_request() end |
#list_nodes(params = {}) ⇒ Types::ListNodesResult
Takes in filters and returns a list of managed nodes matching the filter criteria.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9242 9243 9244 9245 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9242 def list_nodes(params = {}, = {}) req = build_request(:list_nodes, params) req.send_request() end |
#list_nodes_summary(params = {}) ⇒ Types::ListNodesSummaryResult
Generates a summary of managed instance/node metadata based on the filters and aggregators you specify. Results are grouped by the input aggregator you specify.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9365 9366 9367 9368 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9365 def list_nodes_summary(params = {}, = {}) req = build_request(:list_nodes_summary, 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.
9425 9426 9427 9428 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9425 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 tool in Amazon Web Services Systems Manager.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
9491 9492 9493 9494 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9491 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.
9546 9547 9548 9549 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9546 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.
9621 9622 9623 9624 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9621 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.
9701 9702 9703 9704 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9701 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.
9738 9739 9740 9741 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9738 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.
9790 9791 9792 9793 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9790 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.
For State Manager associations, this represents the time when compliance status was captured by the Systems Manager service during its internal compliance aggregation workflow, not necessarily when the association was executed on the managed node. State Manager updates compliance information for all associations on an instance whenever any association executes, which may result in multiple associations showing the same execution time.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example,
approvedfor patches, orFailedfor 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'
9924 9925 9926 9927 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9924 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.
9973 9974 9975 9976 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 9973 def put_inventory(params = {}, = {}) req = build_request(:put_inventory, params) req.send_request() end |
#put_parameter(params = {}) ⇒ Types::PutParameterResult
Create or update a parameter in Parameter Store.
GetParameter, GetParameters, and PutParameter API calls for your
Amazon Web Services account and Amazon Web Services Region. By
default, Parameter Store is configured with a standard throughput
quota suitable for low- to moderate-volume workloads. Applications
that retrieve configuration data infrequently or operate at smaller
scale can use this default setting without additional cost.
For higher-volume workloads, you can enable higher throughput. This
increases the maximum number of supported transactions per second for
your account and Region. Increased throughput supports applications
and workloads that need concurrent access to multiple parameters. If
you experience ThrottlingException: Rate exceeded errors, enable
higher throughput. For more information, see Changing Parameter Store
throughput.
10360 10361 10362 10363 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 10360 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. The following resources support Systems Manager resource policies.
OpsItemGroup- The resource policy forOpsItemGroupenables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).Parameter- The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.
To share a
SecureStringparameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.While you can share a parameter using the Systems Manager
PutResourcePolicyoperation, we recommend using Resource Access Manager (RAM) instead. This is because usingPutResourcePolicyrequires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the--sharedoption.For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide
Document– Shares the document using Resource Access Manager (RAM). For more information about sharing documents, see Sharing Systems Manager documents in the Amazon Web Services Systems Manager User Guide.
While you can share a document using the Systems Manager
PutResourcePolicy operation, we recommend using Resource Access
Manager (RAM) instead. Using PutResourcePolicy requires an extra
step. You must promote the document to a standard RAM Resource Share
using the RAM PromoteResourceShareCreatedFromPolicy API
operation. Otherwise, the Systems Manager ListDocuments API
operation won't return the document when filtering for shared
documents. The Amazon Web Services Config
PutRemediationConfigurations API operation also can't use the
document.
10469 10470 10471 10472 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 10469 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#register_default_host_management_configuration(params = {}) ⇒ Types::RegisterDefaultHostManagementConfigurationResult
Enables Default Host Management Configuration (DHMC) for the current Amazon Web Services account and Amazon Web Services Region. With DHMC enabled, you don't need to configure additional resources, such as an instance profile, to use your Amazon EC2 instances as managed nodes in Amazon Web Services Systems Manager.
To use this operation, you must have the following permissions:
You need the
ssm:GetServiceSettingandssm:UpdateServiceSettingpermissions for the/ssm/managed-instance/default-ec2-instance-management-roleservice setting.You need the
iam:GetRoleandiam:PassRolepermissions for the role used for Default Host Management Configuration.
If PermissionModel is SERVICE_MANAGED, you also need the
iam:CreateRole and iam:AttachRolePolicy permissions so that Amazon
Web Services Systems Manager can create and configure the role on your
behalf.
10547 10548 10549 10550 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 10547 def register_default_host_management_configuration(params = {}, = {}) req = build_request(:register_default_host_management_configuration, 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.
10582 10583 10584 10585 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 10582 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.
10616 10617 10618 10619 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 10616 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.
10726 10727 10728 10729 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 10726 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.
10985 10986 10987 10988 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 10985 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.
11046 11047 11048 11049 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11046 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.
11118 11119 11120 11121 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11118 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.
11158 11159 11160 11161 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11158 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.
11208 11209 11210 11211 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11208 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.
11467 11468 11469 11470 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11467 def send_command(params = {}, = {}) req = build_request(:send_command, params) req.send_request() end |
#start_access_request(params = {}) ⇒ Types::StartAccessRequestResponse
Starts the workflow for just-in-time node access sessions.
11514 11515 11516 11517 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11514 def start_access_request(params = {}, = {}) req = build_request(:start_access_request, 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.
11538 11539 11540 11541 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11538 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.
11736 11737 11738 11739 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11736 def start_automation_execution(params = {}, = {}) req = build_request(:start_automation_execution, params) req.send_request() end |
#start_change_request_execution(params = {}) ⇒ Types::StartChangeRequestExecutionResult
Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.
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.
11924 11925 11926 11927 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 11924 def start_change_request_execution(params = {}, = {}) req = build_request(:start_change_request_execution, params) req.send_request() end |
#start_execution_preview(params = {}) ⇒ Types::StartExecutionPreviewResponse
Initiates the process of creating a preview showing the effects that running a specified Automation runbook would have on the targeted resources.
12025 12026 12027 12028 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12025 def start_execution_preview(params = {}, = {}) req = build_request(:start_execution_preview, 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.
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.
12108 12109 12110 12111 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12108 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.
12135 12136 12137 12138 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12135 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.
12165 12166 12167 12168 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12165 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.
Parameter names can't contain spaces. The service removes any spaces
specified for the beginning or end of a parameter name. If the
specified name for a parameter contains spaces between characters, the
request fails with a ValidationException error.
12217 12218 12219 12220 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12217 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.
12640 12641 12642 12643 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12640 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.
12756 12757 12758 12759 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12756 def update_association_status(params = {}, = {}) req = build_request(:update_association_status, params) req.send_request() end |
#update_cloud_connector(params = {}) ⇒ Types::UpdateCloudConnectorResult
Updates an existing cloud connector with new configuration details.
12825 12826 12827 12828 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12825 def update_cloud_connector(params = {}, = {}) req = build_request(:update_cloud_connector, params) req.send_request() end |
#update_document(params = {}) ⇒ Types::UpdateDocumentResult
Updates one or more values for an SSM document.
12949 12950 12951 12952 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12949 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.
apply-only-at-cron-interval parameter.
12991 12992 12993 12994 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 12991 def update_document_default_version(params = {}, = {}) req = build_request(:update_document_default_version, params) req.send_request() end |
#update_document_metadata(params = {}) ⇒ Struct
Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.
Updates information related to approval reviews for a specific version of a change template in Change Manager.
13040 13041 13042 13043 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 13040 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.
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.
13181 13182 13183 13184 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 13181 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.
13275 13276 13277 13278 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 13275 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 aRUN_COMMANDtask fromAWS-RunPowerShellScripttoAWS-RunShellScript.ServiceRoleArnTaskInvocationParametersPriorityMaxConcurrencyMaxErrors
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.
13650 13651 13652 13653 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 13650 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.
13694 13695 13696 13697 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 13694 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 Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
13850 13851 13852 13853 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 13850 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.
13891 13892 13893 13894 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 13891 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.
PatchFilters for each
supported operating system type, see PatchFilter.
14121 14122 14123 14124 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 14121 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.
SyncType.
14176 14177 14178 14179 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 14176 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.
14276 14277 14278 14279 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 14276 def update_service_setting(params = {}, = {}) req = build_request(:update_service_setting, params) req.send_request() end |
#validate_cloud_connector(params = {}) ⇒ Types::ValidateCloudConnectorResult
Validates the configuration and connectivity of a cloud connector.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
14323 14324 14325 14326 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 14323 def validate_cloud_connector(params = {}, = {}) req = build_request(:validate_cloud_connector, 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 |
14438 14439 14440 14441 14442 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 14438 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |