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.
-
#cancel_command(params = {}) ⇒ Struct
Attempts to cancel the command specified by the Command ID.
-
#cancel_maintenance_window_execution(params = {}) ⇒ Types::CancelMaintenanceWindowExecutionResult
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running.
-
#create_activation(params = {}) ⇒ Types::CreateActivationResult
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager.
-
#create_association(params = {}) ⇒ Types::CreateAssociationResult
A State Manager association defines the state that you want to maintain on your instances.
-
#create_association_batch(params = {}) ⇒ Types::CreateAssociationBatchResult
Associates the specified Systems Manager document with the specified instances or targets.
-
#create_document(params = {}) ⇒ Types::CreateDocumentResult
Creates a Systems Manager (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, Systems Manager calls this API action 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 Systems Manager document from the specified instance.
-
#delete_document(params = {}) ⇒ Struct
Deletes the Systems Manager document and all instance associations to the document.
-
#delete_inventory(params = {}) ⇒ Types::DeleteInventoryResult
Delete a custom inventory type or the data associated with a custom Inventory type.
-
#delete_maintenance_window(params = {}) ⇒ Types::DeleteMaintenanceWindowResult
Deletes a maintenance window.
-
#delete_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.
-
#deregister_managed_instance(params = {}) ⇒ Struct
Removes the server or virtual machine from the list of registered servers.
-
#deregister_patch_baseline_for_patch_group(params = {}) ⇒ Types::DeregisterPatchBaselineForPatchGroupResult
Removes a patch group from a patch baseline.
-
#deregister_target_from_maintenance_window(params = {}) ⇒ Types::DeregisterTargetFromMaintenanceWindowResult
Removes a target from a maintenance window.
-
#deregister_task_from_maintenance_window(params = {}) ⇒ Types::DeregisterTaskFromMaintenanceWindowResult
Removes a task from a maintenance window.
-
#describe_activations(params = {}) ⇒ Types::DescribeActivationsResult
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
-
#describe_association(params = {}) ⇒ Types::DescribeAssociationResult
Describes the association for the specified target or instance.
-
#describe_association_execution_targets(params = {}) ⇒ Types::DescribeAssociationExecutionTargetsResult
Use this API action to view information about a specific execution of a specific association.
-
#describe_association_executions(params = {}) ⇒ Types::DescribeAssociationExecutionsResult
Use this API action to view all executions for a specific association ID.
-
#describe_automation_executions(params = {}) ⇒ Types::DescribeAutomationExecutionsResult
Provides details about all active and terminated Automation executions.
-
#describe_automation_step_executions(params = {}) ⇒ Types::DescribeAutomationStepExecutionsResult
Information about all active and terminated step executions in an Automation workflow.
-
#describe_available_patches(params = {}) ⇒ Types::DescribeAvailablePatchesResult
Lists all patches eligible to be included in a patch baseline.
-
#describe_document(params = {}) ⇒ Types::DescribeDocumentResult
Describes the specified Systems Manager document.
-
#describe_document_permission(params = {}) ⇒ Types::DescribeDocumentPermissionResponse
Describes the permissions for a Systems Manager document.
-
#describe_effective_instance_associations(params = {}) ⇒ Types::DescribeEffectiveInstanceAssociationsResult
All associations for the instance(s).
-
#describe_effective_patches_for_patch_baseline(params = {}) ⇒ Types::DescribeEffectivePatchesForPatchBaselineResult
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
-
#describe_instance_associations_status(params = {}) ⇒ Types::DescribeInstanceAssociationsStatusResult
The status of the associations for the instance(s).
-
#describe_instance_information(params = {}) ⇒ Types::DescribeInstanceInformationResult
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
-
#describe_instance_patch_states(params = {}) ⇒ Types::DescribeInstancePatchStatesResult
Retrieves the high-level patch state of one or more instances.
-
#describe_instance_patch_states_for_patch_group(params = {}) ⇒ Types::DescribeInstancePatchStatesForPatchGroupResult
Retrieves the high-level patch state for the instances in the specified patch group.
-
#describe_instance_patches(params = {}) ⇒ Types::DescribeInstancePatchesResult
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
-
#describe_inventory_deletions(params = {}) ⇒ Types::DescribeInventoryDeletionsResult
Describes a specific delete inventory operation.
-
#describe_maintenance_window_execution_task_invocations(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionTaskInvocationsResult
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
-
#describe_maintenance_window_execution_tasks(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionTasksResult
For a given maintenance window execution, lists the tasks that were run.
-
#describe_maintenance_window_executions(params = {}) ⇒ Types::DescribeMaintenanceWindowExecutionsResult
Lists the executions of a maintenance window.
-
#describe_maintenance_window_schedule(params = {}) ⇒ Types::DescribeMaintenanceWindowScheduleResult
Retrieves information about upcoming executions of a maintenance window.
-
#describe_maintenance_window_targets(params = {}) ⇒ Types::DescribeMaintenanceWindowTargetsResult
Lists the targets registered with the maintenance window.
-
#describe_maintenance_window_tasks(params = {}) ⇒ Types::DescribeMaintenanceWindowTasksResult
Lists the tasks in a maintenance window.
-
#describe_maintenance_windows(params = {}) ⇒ Types::DescribeMaintenanceWindowsResult
Retrieves the maintenance windows in an AWS account.
-
#describe_maintenance_windows_for_target(params = {}) ⇒ Types::DescribeMaintenanceWindowsForTargetResult
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
-
#describe_ops_items(params = {}) ⇒ Types::DescribeOpsItemsResponse
Query a set of OpsItems.
-
#describe_parameters(params = {}) ⇒ Types::DescribeParametersResult
Get information about a parameter.
-
#describe_patch_baselines(params = {}) ⇒ Types::DescribePatchBaselinesResult
Lists the patch baselines in your AWS account.
-
#describe_patch_group_state(params = {}) ⇒ Types::DescribePatchGroupStateResult
Returns high-level aggregated patch compliance state for a patch group.
-
#describe_patch_groups(params = {}) ⇒ Types::DescribePatchGroupsResult
Lists all patch groups that have been registered with patch baselines.
-
#describe_patch_properties(params = {}) ⇒ Types::DescribePatchPropertiesResult
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches.
-
#describe_sessions(params = {}) ⇒ Types::DescribeSessionsResponse
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
-
#get_automation_execution(params = {}) ⇒ Types::GetAutomationExecutionResult
Get detailed information about a particular Automation execution.
-
#get_calendar_state(params = {}) ⇒ Types::GetCalendarStateResponse
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time.
-
#get_command_invocation(params = {}) ⇒ Types::GetCommandInvocationResult
Returns detailed information about command execution for an invocation or plugin.
-
#get_connection_status(params = {}) ⇒ Types::GetConnectionStatusResponse
Retrieves the Session Manager connection status for an instance 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 instance uses.
-
#get_document(params = {}) ⇒ Types::GetDocumentResult
Gets the contents of the specified Systems Manager document.
-
#get_inventory(params = {}) ⇒ Types::GetInventoryResult
Query inventory information.
-
#get_inventory_schema(params = {}) ⇒ Types::GetInventorySchemaResult
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
-
#get_maintenance_window(params = {}) ⇒ Types::GetMaintenanceWindowResult
Retrieves a maintenance window.
-
#get_maintenance_window_execution(params = {}) ⇒ Types::GetMaintenanceWindowExecutionResult
Retrieves details about a specific a maintenance window execution.
-
#get_maintenance_window_execution_task(params = {}) ⇒ Types::GetMaintenanceWindowExecutionTaskResult
Retrieves the details about a specific task run as part of a maintenance window execution.
-
#get_maintenance_window_execution_task_invocation(params = {}) ⇒ Types::GetMaintenanceWindowExecutionTaskInvocationResult
Retrieves information about a specific task running on a specific target.
-
#get_maintenance_window_task(params = {}) ⇒ Types::GetMaintenanceWindowTaskResult
Lists the tasks in a maintenance window.
-
#get_ops_item(params = {}) ⇒ Types::GetOpsItemResponse
Get information about an OpsItem by using the ID.
-
#get_ops_metadata(params = {}) ⇒ Types::GetOpsMetadataResult
View operational metadata related to an application in Application Manager.
-
#get_ops_summary(params = {}) ⇒ Types::GetOpsSummaryResult
View a summary of OpsItems based on specified filters and aggregators.
-
#get_parameter(params = {}) ⇒ Types::GetParameterResult
Get information about a parameter by using the parameter name.
-
#get_parameter_history(params = {}) ⇒ Types::GetParameterHistoryResult
Retrieves the history of all changes to a parameter.
-
#get_parameters(params = {}) ⇒ Types::GetParametersResult
Get details of a parameter.
-
#get_parameters_by_path(params = {}) ⇒ Types::GetParametersByPathResult
Retrieve information about one or more parameters in a specific hierarchy.
-
#get_patch_baseline(params = {}) ⇒ Types::GetPatchBaselineResult
Retrieves information about a patch baseline.
-
#get_patch_baseline_for_patch_group(params = {}) ⇒ Types::GetPatchBaselineForPatchGroupResult
Retrieves the patch baseline that should be used for the specified patch group.
-
#get_service_setting(params = {}) ⇒ Types::GetServiceSettingResult
ServiceSetting
is an account-level setting for an AWS service. -
#label_parameter_version(params = {}) ⇒ Types::LabelParameterVersionResult
A parameter label is a user-defined alias to help you manage different versions of a parameter.
-
#list_association_versions(params = {}) ⇒ Types::ListAssociationVersionsResult
Retrieves all versions of an association for a specific association ID.
-
#list_associations(params = {}) ⇒ Types::ListAssociationsResult
Returns all State Manager associations in the current AWS account and Region.
-
#list_command_invocations(params = {}) ⇒ Types::ListCommandInvocationsResult
An invocation is copy of a command sent to a specific instance.
-
#list_commands(params = {}) ⇒ Types::ListCommandsResult
Lists the commands requested by users of the AWS account.
-
#list_compliance_items(params = {}) ⇒ Types::ListComplianceItemsResult
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
-
#list_compliance_summaries(params = {}) ⇒ Types::ListComplianceSummariesResult
Returns a summary count of compliant and non-compliant resources for a compliance type.
-
#list_document_metadata_history(params = {}) ⇒ Types::ListDocumentMetadataHistoryResponse
Information about approval reviews for a version of an SSM document.
-
#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 AWS account and Region.
-
#list_inventory_entries(params = {}) ⇒ Types::ListInventoryEntriesResult
A list of inventory items returned by the request.
-
#list_ops_item_events(params = {}) ⇒ Types::ListOpsItemEventsResponse
Returns a list of all OpsItem events in the current AWS account and Region.
-
#list_ops_metadata(params = {}) ⇒ Types::ListOpsMetadataResult
Systems Manager calls this API action 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 Systems Manager document publicly or privately.
-
#put_compliance_items(params = {}) ⇒ Struct
Registers a compliance type and other compliance details on a designated resource.
-
#put_inventory(params = {}) ⇒ Types::PutInventoryResult
Bulk update custom inventory items on one more instance.
-
#put_parameter(params = {}) ⇒ Types::PutParameterResult
Add a parameter to the system.
-
#register_default_patch_baseline(params = {}) ⇒ Types::RegisterDefaultPatchBaselineResult
Defines the default patch baseline for the relevant operating system.
-
#register_patch_baseline_for_patch_group(params = {}) ⇒ Types::RegisterPatchBaselineForPatchGroupResult
Registers a patch baseline for a patch group.
-
#register_target_with_maintenance_window(params = {}) ⇒ Types::RegisterTargetWithMaintenanceWindowResult
Registers a target with a maintenance window.
-
#register_task_with_maintenance_window(params = {}) ⇒ Types::RegisterTaskWithMaintenanceWindowResult
Adds a new task to a maintenance window.
-
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes tag keys from the specified resource.
-
#reset_service_setting(params = {}) ⇒ Types::ResetServiceSettingResult
ServiceSetting
is an account-level setting for an AWS service. -
#resume_session(params = {}) ⇒ Types::ResumeSessionResponse
Reconnects a session to an instance after it has been disconnected.
-
#send_automation_signal(params = {}) ⇒ Struct
Sends a signal to an Automation execution to change the current behavior or status of the execution.
-
#send_command(params = {}) ⇒ Types::SendCommandResult
Runs commands on one or more managed instances.
-
#start_associations_once(params = {}) ⇒ Struct
Use this API action to run an association immediately and only one time.
-
#start_automation_execution(params = {}) ⇒ Types::StartAutomationExecutionResult
Initiates execution of an Automation document.
-
#start_change_request_execution(params = {}) ⇒ Types::StartChangeRequestExecutionResult
Creates a change request for Change Manager.
-
#start_session(params = {}) ⇒ Types::StartSessionResponse
Initiates a connection to a target (for example, an instance) for a Session Manager session.
-
#stop_automation_execution(params = {}) ⇒ Struct
Stop an Automation that is currently running.
-
#terminate_session(params = {}) ⇒ Types::TerminateSessionResponse
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance.
-
#update_association(params = {}) ⇒ Types::UpdateAssociationResult
Updates an association.
-
#update_association_status(params = {}) ⇒ Types::UpdateAssociationStatusResult
Updates the status of the Systems Manager document associated with the specified instance.
-
#update_document(params = {}) ⇒ Types::UpdateDocumentResult
Updates one or more values for an SSM document.
-
#update_document_default_version(params = {}) ⇒ Types::UpdateDocumentDefaultVersionResult
Set the default version of a document.
-
#update_document_metadata(params = {}) ⇒ Struct
Updates information related to approval reviews for a specific version of a document.
-
#update_maintenance_window(params = {}) ⇒ Types::UpdateMaintenanceWindowResult
Updates an existing maintenance window.
-
#update_maintenance_window_target(params = {}) ⇒ Types::UpdateMaintenanceWindowTargetResult
Modifies the target of an existing maintenance window.
-
#update_maintenance_window_task(params = {}) ⇒ Types::UpdateMaintenanceWindowTaskResult
Modifies a task assigned to a maintenance window.
-
#update_managed_instance_role(params = {}) ⇒ Struct
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM).
-
#update_ops_item(params = {}) ⇒ Struct
Edit or change an OpsItem.
-
#update_ops_metadata(params = {}) ⇒ Types::UpdateOpsMetadataResult
Systems Manager calls this API action when you edit OpsMetadata in Application Manager.
-
#update_patch_baseline(params = {}) ⇒ Types::UpdatePatchBaselineResult
Modifies an existing patch baseline.
-
#update_resource_data_sync(params = {}) ⇒ Struct
Update a resource data sync.
-
#update_service_setting(params = {}) ⇒ Struct
ServiceSetting
is an account-level setting for an AWS service.
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.
334 335 336 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 334 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 documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
420 421 422 423 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 420 def (params = {}, = {}) req = build_request(:add_tags_to_resource, 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.
450 451 452 453 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 450 def cancel_command(params = {}, = {}) req = build_request(:cancel_command, params) req.send_request() end |
#cancel_maintenance_window_execution(params = {}) ⇒ Types::CancelMaintenanceWindowExecutionResult
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
480 481 482 483 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 480 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 server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
594 595 596 597 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 594 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 instances. For example, an association can specify that anti-virus software must be installed and running on your instances, 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 AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances 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 is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
837 838 839 840 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 837 def create_association(params = {}, = {}) req = build_request(:create_association, params) req.send_request() end |
#create_association_batch(params = {}) ⇒ Types::CreateAssociationBatchResult
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
989 990 991 992 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 989 def create_association_batch(params = {}, = {}) req = build_request(:create_association_batch, params) req.send_request() end |
#create_document(params = {}) ⇒ Types::CreateDocumentResult
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
1176 1177 1178 1179 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1176 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.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1314 def create_maintenance_window(params = {}, = {}) req = build_request(:create_maintenance_window, params) req.send_request() end |
#create_ops_item(params = {}) ⇒ Types::CreateOpsItemResponse
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
1487 1488 1489 1490 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1487 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, Systems Manager calls this API action to specify information about the new application, including the application type.
1525 1526 1527 1528 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1525 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.
1698 1699 1700 1701 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1698 def create_patch_baseline(params = {}, = {}) req = build_request(:create_patch_baseline, params) req.send_request() end |
#create_resource_data_sync(params = {}) ⇒ Struct
A resource data sync helps you view data from multiple sources in a
single location. Systems Manager offers two types of resource data
sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the
SyncToDestination
type to synchronize Inventory data from multiple
AWS Regions to a single S3 bucket. For more information, see
Configuring Resource Data Sync for Inventory in the AWS 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 AWS Regions to a single S3 bucket. This
type can synchronize OpsItems and OpsData from multiple AWS accounts
and Regions or EntireOrganization
by using AWS Organizations. For
more information, see Setting up Systems Manager Explorer to display
data from multiple accounts and Regions in the AWS Systems
Manager User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
1796 1797 1798 1799 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1796 def create_resource_data_sync(params = {}, = {}) req = build_request(:create_resource_data_sync, params) req.send_request() end |
#delete_activation(params = {}) ⇒ Struct
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
1822 1823 1824 1825 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1822 def delete_activation(params = {}, = {}) req = build_request(:delete_activation, params) req.send_request() end |
#delete_association(params = {}) ⇒ Struct
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
1859 1860 1861 1862 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1859 def delete_association(params = {}, = {}) req = build_request(:delete_association, params) req.send_request() end |
#delete_document(params = {}) ⇒ Struct
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
1904 1905 1906 1907 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1904 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.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 1974 def delete_inventory(params = {}, = {}) req = build_request(:delete_inventory, params) req.send_request() end |
#delete_maintenance_window(params = {}) ⇒ Types::DeleteMaintenanceWindowResult
Deletes a maintenance window.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2002 def delete_maintenance_window(params = {}, = {}) req = build_request(:delete_maintenance_window, params) req.send_request() end |
#delete_ops_metadata(params = {}) ⇒ Struct
Delete OpsMetadata related to an application.
2024 2025 2026 2027 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2024 def (params = {}, = {}) req = build_request(:delete_ops_metadata, params) req.send_request() end |
#delete_parameter(params = {}) ⇒ Struct
Delete a parameter from the system.
2046 2047 2048 2049 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2046 def delete_parameter(params = {}, = {}) req = build_request(:delete_parameter, params) req.send_request() end |
#delete_parameters(params = {}) ⇒ Types::DeleteParametersResult
Delete a list of parameters.
2078 2079 2080 2081 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2078 def delete_parameters(params = {}, = {}) req = build_request(:delete_parameters, params) req.send_request() end |
#delete_patch_baseline(params = {}) ⇒ Types::DeletePatchBaselineResult
Deletes a patch baseline.
2106 2107 2108 2109 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2106 def delete_patch_baseline(params = {}, = {}) req = build_request(:delete_patch_baseline, params) req.send_request() end |
#delete_resource_data_sync(params = {}) ⇒ Struct
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
2135 2136 2137 2138 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2135 def delete_resource_data_sync(params = {}, = {}) req = build_request(:delete_resource_data_sync, params) req.send_request() end |
#deregister_managed_instance(params = {}) ⇒ Struct
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2161 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.
2196 2197 2198 2199 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2196 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.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2236 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.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2270 def deregister_task_from_maintenance_window(params = {}, = {}) req = build_request(:deregister_task_from_maintenance_window, params) req.send_request() end |
#describe_activations(params = {}) ⇒ Types::DescribeActivationsResult
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2333 2334 2335 2336 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2333 def describe_activations(params = {}, = {}) req = build_request(:describe_activations, params) req.send_request() end |
#describe_association(params = {}) ⇒ Types::DescribeAssociationResult
Describes the association for the specified target or instance. If you
created the association by using the Targets
parameter, then you
must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems
Manager document, then you retrieve the association by specifying the
document name and the instance ID.
2424 2425 2426 2427 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2424 def describe_association(params = {}, = {}) req = build_request(:describe_association, params) req.send_request() end |
#describe_association_execution_targets(params = {}) ⇒ Types::DescribeAssociationExecutionTargetsResult
Use this API action to view information about a specific execution of a specific association.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2499 2500 2501 2502 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2499 def describe_association_execution_targets(params = {}, = {}) req = build_request(:describe_association_execution_targets, params) req.send_request() end |
#describe_association_executions(params = {}) ⇒ Types::DescribeAssociationExecutionsResult
Use this API action to view all executions for a specific association ID.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2569 2570 2571 2572 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2569 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.
2676 2677 2678 2679 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2676 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.
2777 2778 2779 2780 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2777 def describe_automation_step_executions(params = {}, = {}) req = build_request(:describe_automation_step_executions, params) req.send_request() end |
#describe_available_patches(params = {}) ⇒ Types::DescribeAvailablePatchesResult
Lists all patches eligible to be included in a patch baseline.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2849 2850 2851 2852 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2849 def describe_available_patches(params = {}, = {}) req = build_request(:describe_available_patches, params) req.send_request() end |
#describe_document(params = {}) ⇒ Types::DescribeDocumentResult
Describes the specified Systems Manager document.
2927 2928 2929 2930 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2927 def describe_document(params = {}, = {}) req = build_request(:describe_document, params) req.send_request() end |
#describe_document_permission(params = {}) ⇒ Types::DescribeDocumentPermissionResponse
Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
2981 2982 2983 2984 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 2981 def (params = {}, = {}) req = build_request(:describe_document_permission, params) req.send_request() end |
#describe_effective_instance_associations(params = {}) ⇒ Types::DescribeEffectiveInstanceAssociationsResult
All associations for the instance(s).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3028 3029 3030 3031 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3028 def describe_effective_instance_associations(params = {}, = {}) req = build_request(:describe_effective_instance_associations, params) req.send_request() end |
#describe_effective_patches_for_patch_baseline(params = {}) ⇒ Types::DescribeEffectivePatchesForPatchBaselineResult
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3100 3101 3102 3103 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3100 def describe_effective_patches_for_patch_baseline(params = {}, = {}) req = build_request(:describe_effective_patches_for_patch_baseline, params) req.send_request() end |
#describe_instance_associations_status(params = {}) ⇒ Types::DescribeInstanceAssociationsStatusResult
The status of the associations for the instance(s).
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3155 3156 3157 3158 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3155 def describe_instance_associations_status(params = {}, = {}) req = build_request(:describe_instance_associations_status, params) req.send_request() end |
#describe_instance_information(params = {}) ⇒ Types::DescribeInstanceInformationResult
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3257 3258 3259 3260 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3257 def describe_instance_information(params = {}, = {}) req = build_request(:describe_instance_information, params) req.send_request() end |
#describe_instance_patch_states(params = {}) ⇒ Types::DescribeInstancePatchStatesResult
Retrieves the high-level patch state of one or more instances.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3318 3319 3320 3321 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3318 def describe_instance_patch_states(params = {}, = {}) req = build_request(:describe_instance_patch_states, params) req.send_request() end |
#describe_instance_patch_states_for_patch_group(params = {}) ⇒ Types::DescribeInstancePatchStatesForPatchGroupResult
Retrieves the high-level patch state for the instances in the specified patch group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3396 3397 3398 3399 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3396 def describe_instance_patch_states_for_patch_group(params = {}, = {}) req = build_request(:describe_instance_patch_states_for_patch_group, params) req.send_request() end |
#describe_instance_patches(params = {}) ⇒ Types::DescribeInstancePatchesResult
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3458 3459 3460 3461 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3458 def describe_instance_patches(params = {}, = {}) req = build_request(:describe_instance_patches, params) req.send_request() end |
#describe_inventory_deletions(params = {}) ⇒ Types::DescribeInventoryDeletionsResult
Describes a specific delete inventory operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3514 3515 3516 3517 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3514 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.
3586 3587 3588 3589 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3586 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.
3650 3651 3652 3653 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3650 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.
3718 3719 3720 3721 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3718 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.
3790 3791 3792 3793 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3790 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.
3854 3855 3856 3857 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3854 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 do not 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.
3936 3937 3938 3939 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3936 def describe_maintenance_window_tasks(params = {}, = {}) req = build_request(:describe_maintenance_window_tasks, params) req.send_request() end |
#describe_maintenance_windows(params = {}) ⇒ Types::DescribeMaintenanceWindowsResult
Retrieves the maintenance windows in an AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3998 3999 4000 4001 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 3998 def describe_maintenance_windows(params = {}, = {}) req = build_request(:describe_maintenance_windows, params) req.send_request() end |
#describe_maintenance_windows_for_target(params = {}) ⇒ Types::DescribeMaintenanceWindowsForTargetResult
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4054 4055 4056 4057 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4054 def describe_maintenance_windows_for_target(params = {}, = {}) req = build_request(:describe_maintenance_windows_for_target, params) req.send_request() end |
#describe_ops_items(params = {}) ⇒ Types::DescribeOpsItemsResponse
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4192 4193 4194 4195 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4192 def describe_ops_items(params = {}, = {}) req = build_request(:describe_ops_items, params) req.send_request() end |
#describe_parameters(params = {}) ⇒ Types::DescribeParametersResult
Get information about a parameter.
MaxResults
in the request, the response includes information up to
the limit specified. The number of items returned, however, can be
between zero and the value of MaxResults
. If the service reaches an
internal limit while processing the results, it stops the operation
and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next
set of results.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4275 4276 4277 4278 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4275 def describe_parameters(params = {}, = {}) req = build_request(:describe_parameters, params) req.send_request() end |
#describe_patch_baselines(params = {}) ⇒ Types::DescribePatchBaselinesResult
Lists the patch baselines in your AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4331 4332 4333 4334 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4331 def describe_patch_baselines(params = {}, = {}) req = build_request(:describe_patch_baselines, params) req.send_request() end |
#describe_patch_group_state(params = {}) ⇒ Types::DescribePatchGroupStateResult
Returns high-level aggregated patch compliance state for a patch group.
4376 4377 4378 4379 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4376 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.
4445 4446 4447 4448 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4445 def describe_patch_groups(params = {}, = {}) req = build_request(:describe_patch_groups, params) req.send_request() end |
#describe_patch_properties(params = {}) ⇒ Types::DescribePatchPropertiesResult
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
- AMAZON_LINUX
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
- AMAZON_LINUX_2
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
- CENTOS
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
- DEBIAN
Valid properties: PRODUCT, PRIORITY
- MACOS
Valid properties: PRODUCT, CLASSIFICATION
- ORACLE_LINUX
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
- REDHAT_ENTERPRISE_LINUX
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
- SUSE
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
- UBUNTU
Valid properties: PRODUCT, PRIORITY
- WINDOWS
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4549 4550 4551 4552 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4549 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.
4614 4615 4616 4617 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4614 def describe_sessions(params = {}, = {}) req = build_request(:describe_sessions, params) req.send_request() end |
#get_automation_execution(params = {}) ⇒ Types::GetAutomationExecutionResult
Get detailed information about a particular Automation execution.
4758 4759 4760 4761 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4758 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 the AWS Systems Manager Change Calendar at an
optional, specified time. If you specify a time, GetCalendarState
returns the state of the calendar at a specific time, and returns the
next time that the Change Calendar state will transition. If you do
not specify a time, GetCalendarState
assumes 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 Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
4820 4821 4822 4823 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4820 def get_calendar_state(params = {}, = {}) req = build_request(:get_calendar_state, params) req.send_request() end |
#get_command_invocation(params = {}) ⇒ Types::GetCommandInvocationResult
Returns detailed information about command execution for an invocation or plugin.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- command_executed
4902 4903 4904 4905 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4902 def get_command_invocation(params = {}, = {}) req = build_request(:get_command_invocation, params) req.send_request() end |
#get_connection_status(params = {}) ⇒ Types::GetConnectionStatusResponse
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
4934 4935 4936 4937 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4934 def get_connection_status(params = {}, = {}) req = build_request(:get_connection_status, params) req.send_request() end |
#get_default_patch_baseline(params = {}) ⇒ Types::GetDefaultPatchBaselineResult
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
4969 4970 4971 4972 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 4969 def get_default_patch_baseline(params = {}, = {}) req = build_request(:get_default_patch_baseline, params) req.send_request() end |
#get_deployable_patch_snapshot_for_instance(params = {}) ⇒ Types::GetDeployablePatchSnapshotForInstanceResult
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
5010 5011 5012 5013 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5010 def get_deployable_patch_snapshot_for_instance(params = {}, = {}) req = build_request(:get_deployable_patch_snapshot_for_instance, params) req.send_request() end |
#get_document(params = {}) ⇒ Types::GetDocumentResult
Gets the contents of the specified Systems Manager document.
5080 5081 5082 5083 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5080 def get_document(params = {}, = {}) req = build_request(:get_document, params) req.send_request() end |
#get_inventory(params = {}) ⇒ Types::GetInventoryResult
Query inventory information.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5173 5174 5175 5176 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5173 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.
5234 5235 5236 5237 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/client.rb', line 5234 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.