@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSimpleSystemsManagement extends Object implements AWSSimpleSystemsManagement
AWSSimpleSystemsManagement
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds or overwrites one or more tags for the specified resource.
|
AssociateOpsItemRelatedItemResult |
associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest request)
Associates a related item to a Systems Manager OpsCenter OpsItem.
|
CancelCommandResult |
cancelCommand(CancelCommandRequest request)
Attempts to cancel the command specified by the Command ID.
|
CancelMaintenanceWindowExecutionResult |
cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest request)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't
already starting running.
|
CreateActivationResult |
createActivation(CreateActivationRequest request)
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.
|
CreateAssociationResult |
createAssociation(CreateAssociationRequest request)
A State Manager association defines the state that you want to maintain on your managed nodes.
|
CreateAssociationBatchResult |
createAssociationBatch(CreateAssociationBatchRequest request)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed
nodes or targets.
|
CreateDocumentResult |
createDocument(CreateDocumentRequest request)
Creates a Amazon Web Services Systems Manager (SSM document).
|
CreateMaintenanceWindowResult |
createMaintenanceWindow(CreateMaintenanceWindowRequest request)
Creates a new maintenance window.
|
CreateOpsItemResult |
createOpsItem(CreateOpsItemRequest request)
Creates a new OpsItem.
|
CreateOpsMetadataResult |
createOpsMetadata(CreateOpsMetadataRequest request)
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.
|
CreatePatchBaselineResult |
createPatchBaseline(CreatePatchBaselineRequest request)
Creates a patch baseline.
|
CreateResourceDataSyncResult |
createResourceDataSync(CreateResourceDataSyncRequest request)
A resource data sync helps you view data from multiple sources in a single location.
|
DeleteActivationResult |
deleteActivation(DeleteActivationRequest request)
Deletes an activation.
|
DeleteAssociationResult |
deleteAssociation(DeleteAssociationRequest request)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified
managed node.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest request)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the
document.
|
DeleteInventoryResult |
deleteInventory(DeleteInventoryRequest request)
Delete a custom inventory type or the data associated with a custom Inventory type.
|
DeleteMaintenanceWindowResult |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
Deletes a maintenance window.
|
DeleteOpsItemResult |
deleteOpsItem(DeleteOpsItemRequest request)
Delete an OpsItem.
|
DeleteOpsMetadataResult |
deleteOpsMetadata(DeleteOpsMetadataRequest request)
Delete OpsMetadata related to an application.
|
DeleteParameterResult |
deleteParameter(DeleteParameterRequest request)
Delete a parameter from the system.
|
DeleteParametersResult |
deleteParameters(DeleteParametersRequest request)
Delete a list of parameters.
|
DeletePatchBaselineResult |
deletePatchBaseline(DeletePatchBaselineRequest request)
Deletes a patch baseline.
|
DeleteResourceDataSyncResult |
deleteResourceDataSync(DeleteResourceDataSyncRequest request)
Deletes a resource data sync configuration.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes a Systems Manager resource policy.
|
DeregisterManagedInstanceResult |
deregisterManagedInstance(DeregisterManagedInstanceRequest request)
Removes the server or virtual machine from the list of registered servers.
|
DeregisterPatchBaselineForPatchGroupResult |
deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest request)
Removes a patch group from a patch baseline.
|
DeregisterTargetFromMaintenanceWindowResult |
deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest request)
Removes a target from a maintenance window.
|
DeregisterTaskFromMaintenanceWindowResult |
deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest request)
Removes a task from a maintenance window.
|
DescribeActivationsResult |
describeActivations(DescribeActivationsRequest request)
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.
|
DescribeAssociationResult |
describeAssociation(DescribeAssociationRequest request)
Describes the association for the specified target or managed node.
|
DescribeAssociationExecutionsResult |
describeAssociationExecutions(DescribeAssociationExecutionsRequest request)
Views all executions for a specific association ID.
|
DescribeAssociationExecutionTargetsResult |
describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest request)
Views information about a specific execution of a specific association.
|
DescribeAutomationExecutionsResult |
describeAutomationExecutions(DescribeAutomationExecutionsRequest request)
Provides details about all active and terminated Automation executions.
|
DescribeAutomationStepExecutionsResult |
describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest request)
Information about all active and terminated step executions in an Automation workflow.
|
DescribeAvailablePatchesResult |
describeAvailablePatches(DescribeAvailablePatchesRequest request)
Lists all patches eligible to be included in a patch baseline.
|
DescribeDocumentResult |
describeDocument(DescribeDocumentRequest request)
Describes the specified Amazon Web Services Systems Manager document (SSM document).
|
DescribeDocumentPermissionResult |
describeDocumentPermission(DescribeDocumentPermissionRequest request)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).
|
DescribeEffectiveInstanceAssociationsResult |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest request)
All associations for the managed nodes.
|
DescribeEffectivePatchesForPatchBaselineResult |
describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest request)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
DescribeInstanceAssociationsStatusResult |
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest request)
The status of the associations for the managed nodes.
|
DescribeInstanceInformationResult |
describeInstanceInformation(DescribeInstanceInformationRequest request)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent
version, association status, and IP address.
|
DescribeInstancePatchesResult |
describeInstancePatches(DescribeInstancePatchesRequest request)
Retrieves information about the patches on the specified managed node and their state relative to the patch
baseline being used for the node.
|
DescribeInstancePatchStatesResult |
describeInstancePatchStates(DescribeInstancePatchStatesRequest request)
Retrieves the high-level patch state of one or more managed nodes.
|
DescribeInstancePatchStatesForPatchGroupResult |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest request)
Retrieves the high-level patch state for the managed nodes in the specified patch group.
|
DescribeInstancePropertiesResult |
describeInstanceProperties(DescribeInstancePropertiesRequest request)
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
|
DescribeInventoryDeletionsResult |
describeInventoryDeletions(DescribeInventoryDeletionsRequest request)
Describes a specific delete inventory operation.
|
DescribeMaintenanceWindowExecutionsResult |
describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest request)
Lists the executions of a maintenance window.
|
DescribeMaintenanceWindowExecutionTaskInvocationsResult |
describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
DescribeMaintenanceWindowExecutionTasksResult |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request)
For a given maintenance window execution, lists the tasks that were run.
|
DescribeMaintenanceWindowsResult |
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest request)
Retrieves the maintenance windows in an Amazon Web Services account.
|
DescribeMaintenanceWindowScheduleResult |
describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest request)
Retrieves information about upcoming executions of a maintenance window.
|
DescribeMaintenanceWindowsForTargetResult |
describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest request)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
|
DescribeMaintenanceWindowTargetsResult |
describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request)
Lists the targets registered with the maintenance window.
|
DescribeMaintenanceWindowTasksResult |
describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request)
Lists the tasks in a maintenance window.
|
DescribeOpsItemsResult |
describeOpsItems(DescribeOpsItemsRequest request)
Query a set of OpsItems.
|
DescribeParametersResult |
describeParameters(DescribeParametersRequest request)
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
|
DescribePatchBaselinesResult |
describePatchBaselines(DescribePatchBaselinesRequest request)
Lists the patch baselines in your Amazon Web Services account.
|
DescribePatchGroupsResult |
describePatchGroups(DescribePatchGroupsRequest request)
Lists all patch groups that have been registered with patch baselines.
|
DescribePatchGroupStateResult |
describePatchGroupState(DescribePatchGroupStateRequest request)
Returns high-level aggregated patch compliance state information for a patch group.
|
DescribePatchPropertiesResult |
describePatchProperties(DescribePatchPropertiesRequest request)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
DescribeSessionsResult |
describeSessions(DescribeSessionsRequest request)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
DisassociateOpsItemRelatedItemResult |
disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest request)
Deletes the association between an OpsItem and a related item.
|
GetAutomationExecutionResult |
getAutomationExecution(GetAutomationExecutionRequest request)
Get detailed information about a particular Automation execution.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCalendarStateResult |
getCalendarState(GetCalendarStateRequest request)
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
|
GetCommandInvocationResult |
getCommandInvocation(GetCommandInvocationRequest request)
Returns detailed information about command execution for an invocation or plugin.
|
GetConnectionStatusResult |
getConnectionStatus(GetConnectionStatusRequest request)
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready
to receive Session Manager connections.
|
GetDefaultPatchBaselineResult |
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest request)
Retrieves the default patch baseline.
|
GetDeployablePatchSnapshotForInstanceResult |
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest request)
Retrieves the current snapshot for the patch baseline the managed node uses.
|
GetDocumentResult |
getDocument(GetDocumentRequest request)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
|
GetInventoryResult |
getInventory(GetInventoryRequest request)
Query inventory information.
|
GetInventorySchemaResult |
getInventorySchema(GetInventorySchemaRequest request)
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
GetMaintenanceWindowResult |
getMaintenanceWindow(GetMaintenanceWindowRequest request)
Retrieves a maintenance window.
|
GetMaintenanceWindowExecutionResult |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request)
Retrieves details about a specific a maintenance window execution.
|
GetMaintenanceWindowExecutionTaskResult |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request)
Retrieves the details about a specific task run as part of a maintenance window execution.
|
GetMaintenanceWindowExecutionTaskInvocationResult |
getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest request)
Retrieves information about a specific task running on a specific target.
|
GetMaintenanceWindowTaskResult |
getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request)
Retrieves the details of a maintenance window task.
|
GetOpsItemResult |
getOpsItem(GetOpsItemRequest request)
Get information about an OpsItem by using the ID.
|
GetOpsMetadataResult |
getOpsMetadata(GetOpsMetadataRequest request)
View operational metadata related to an application in Application Manager.
|
GetOpsSummaryResult |
getOpsSummary(GetOpsSummaryRequest request)
View a summary of operations metadata (OpsData) based on specified filters and aggregators.
|
GetParameterResult |
getParameter(GetParameterRequest request)
Get information about a single parameter by specifying the parameter name.
|
GetParameterHistoryResult |
getParameterHistory(GetParameterHistoryRequest request)
Retrieves the history of all changes to a parameter.
|
GetParametersResult |
getParameters(GetParametersRequest request)
Get information about one or more parameters by specifying multiple parameter names.
|
GetParametersByPathResult |
getParametersByPath(GetParametersByPathRequest request)
Retrieve information about one or more parameters in a specific hierarchy.
|
GetPatchBaselineResult |
getPatchBaseline(GetPatchBaselineRequest request)
Retrieves information about a patch baseline.
|
GetPatchBaselineForPatchGroupResult |
getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest request)
Retrieves the patch baseline that should be used for the specified patch group.
|
GetResourcePoliciesResult |
getResourcePolicies(GetResourcePoliciesRequest request)
Returns an array of the
Policy object. |
GetServiceSettingResult |
getServiceSetting(GetServiceSettingRequest request)
ServiceSetting is an account-level setting for an Amazon Web Services service. |
LabelParameterVersionResult |
labelParameterVersion(LabelParameterVersionRequest request)
A parameter label is a user-defined alias to help you manage different versions of a parameter.
|
ListAssociationsResult |
listAssociations(ListAssociationsRequest request)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
|
ListAssociationVersionsResult |
listAssociationVersions(ListAssociationVersionsRequest request)
Retrieves all versions of an association for a specific association ID.
|
ListCommandInvocationsResult |
listCommandInvocations(ListCommandInvocationsRequest request)
An invocation is copy of a command sent to a specific managed node.
|
ListCommandsResult |
listCommands(ListCommandsRequest request)
Lists the commands requested by users of the Amazon Web Services account.
|
ListComplianceItemsResult |
listComplianceItems(ListComplianceItemsRequest request)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource
types.
|
ListComplianceSummariesResult |
listComplianceSummaries(ListComplianceSummariesRequest request)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
ListDocumentMetadataHistoryResult |
listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest request)
Information about approval reviews for a version of a change template in Change Manager.
|
ListDocumentsResult |
listDocuments()
Simplified method form for invoking the ListDocuments operation.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest request)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services
Region.
|
ListDocumentVersionsResult |
listDocumentVersions(ListDocumentVersionsRequest request)
List all versions for a document.
|
ListInventoryEntriesResult |
listInventoryEntries(ListInventoryEntriesRequest request)
A list of inventory items returned by the request.
|
ListOpsItemEventsResult |
listOpsItemEvents(ListOpsItemEventsRequest request)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.
|
ListOpsItemRelatedItemsResult |
listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest request)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
|
ListOpsMetadataResult |
listOpsMetadata(ListOpsMetadataRequest request)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata
objects or blobs.
|
ListResourceComplianceSummariesResult |
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest request)
Returns a resource-level summary count.
|
ListResourceDataSyncResult |
listResourceDataSync(ListResourceDataSyncRequest request)
Lists your resource data sync configurations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags assigned to the specified resource.
|
ModifyDocumentPermissionResult |
modifyDocumentPermission(ModifyDocumentPermissionRequest request)
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.
|
PutComplianceItemsResult |
putComplianceItems(PutComplianceItemsRequest request)
Registers a compliance type and other compliance details on a designated resource.
|
PutInventoryResult |
putInventory(PutInventoryRequest request)
Bulk update custom inventory items on one or more managed nodes.
|
PutParameterResult |
putParameter(PutParameterRequest request)
Add a parameter to the system.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Creates or updates a Systems Manager resource policy.
|
RegisterDefaultPatchBaselineResult |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request)
Defines the default patch baseline for the relevant operating system.
|
RegisterPatchBaselineForPatchGroupResult |
registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request)
Registers a patch baseline for a patch group.
|
RegisterTargetWithMaintenanceWindowResult |
registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request)
Registers a target with a maintenance window.
|
RegisterTaskWithMaintenanceWindowResult |
registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request)
Adds a new task to a maintenance window.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes tag keys from the specified resource.
|
ResetServiceSettingResult |
resetServiceSetting(ResetServiceSettingRequest request)
ServiceSetting is an account-level setting for an Amazon Web Services service. |
ResumeSessionResult |
resumeSession(ResumeSessionRequest request)
Reconnects a session to a managed node after it has been disconnected.
|
SendAutomationSignalResult |
sendAutomationSignal(SendAutomationSignalRequest request)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
SendCommandResult |
sendCommand(SendCommandRequest request)
Runs commands on one or more managed nodes.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://ssm.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSSimpleSystemsManagement.setEndpoint(String) , sets the regional endpoint for this
client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAssociationsOnceResult |
startAssociationsOnce(StartAssociationsOnceRequest request)
Runs an association immediately and only one time.
|
StartAutomationExecutionResult |
startAutomationExecution(StartAutomationExecutionRequest request)
Initiates execution of an Automation runbook.
|
StartChangeRequestExecutionResult |
startChangeRequestExecution(StartChangeRequestExecutionRequest request)
Creates a change request for Change Manager.
|
StartSessionResult |
startSession(StartSessionRequest request)
Initiates a connection to a target (for example, a managed node) for a Session Manager session.
|
StopAutomationExecutionResult |
stopAutomationExecution(StopAutomationExecutionRequest request)
Stop an Automation that is currently running.
|
TerminateSessionResult |
terminateSession(TerminateSessionRequest request)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the
managed node.
|
UnlabelParameterVersionResult |
unlabelParameterVersion(UnlabelParameterVersionRequest request)
Remove a label or labels from a parameter.
|
UpdateAssociationResult |
updateAssociation(UpdateAssociationRequest request)
Updates an association.
|
UpdateAssociationStatusResult |
updateAssociationStatus(UpdateAssociationStatusRequest request)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the
specified managed node.
|
UpdateDocumentResult |
updateDocument(UpdateDocumentRequest request)
Updates one or more values for an SSM document.
|
UpdateDocumentDefaultVersionResult |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest request)
Set the default version of a document.
|
UpdateDocumentMetadataResult |
updateDocumentMetadata(UpdateDocumentMetadataRequest request)
Updates information related to approval reviews for a specific version of a change template in Change Manager.
|
UpdateMaintenanceWindowResult |
updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)
Updates an existing maintenance window.
|
UpdateMaintenanceWindowTargetResult |
updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest request)
Modifies the target of an existing maintenance window.
|
UpdateMaintenanceWindowTaskResult |
updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest request)
Modifies a task assigned to a maintenance window.
|
UpdateManagedInstanceRoleResult |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request)
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or
virtual machines (VM).
|
UpdateOpsItemResult |
updateOpsItem(UpdateOpsItemRequest request)
Edit or change an OpsItem.
|
UpdateOpsMetadataResult |
updateOpsMetadata(UpdateOpsMetadataRequest request)
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
|
UpdatePatchBaselineResult |
updatePatchBaseline(UpdatePatchBaselineRequest request)
Modifies an existing patch baseline.
|
UpdateResourceDataSyncResult |
updateResourceDataSync(UpdateResourceDataSyncRequest request)
Update a resource data sync.
|
UpdateServiceSettingResult |
updateServiceSetting(UpdateServiceSettingRequest request)
ServiceSetting is an account-level setting for an Amazon Web Services service. |
AWSSimpleSystemsManagementWaiters |
waiters() |
public void setEndpoint(String endpoint)
AWSSimpleSystemsManagement
Callers can pass in just the endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://ssm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSSimpleSystemsManagement
endpoint
- The endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://ssm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSSimpleSystemsManagement
AWSSimpleSystemsManagement.setEndpoint(String)
, sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSSimpleSystemsManagement
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AWSSimpleSystemsManagement
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResource
in interface AWSSimpleSystemsManagement
public AssociateOpsItemRelatedItemResult associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest request)
AWSSimpleSystemsManagement
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
associateOpsItemRelatedItem
in interface AWSSimpleSystemsManagement
public CancelCommandResult cancelCommand(CancelCommandRequest request)
AWSSimpleSystemsManagement
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.
cancelCommand
in interface AWSSimpleSystemsManagement
public CancelMaintenanceWindowExecutionResult cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest request)
AWSSimpleSystemsManagement
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.
cancelMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
public CreateActivationResult createActivation(CreateActivationRequest request)
AWSSimpleSystemsManagement
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
createActivation
in interface AWSSimpleSystemsManagement
public CreateAssociationResult createAssociation(CreateAssociationRequest request)
AWSSimpleSystemsManagement
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
createAssociation
in interface AWSSimpleSystemsManagement
public CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest request)
AWSSimpleSystemsManagement
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.
createAssociationBatch
in interface AWSSimpleSystemsManagement
public CreateDocumentResult createDocument(CreateDocumentRequest request)
AWSSimpleSystemsManagement
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.
createDocument
in interface AWSSimpleSystemsManagement
public CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
createMaintenanceWindow
in interface AWSSimpleSystemsManagement
public CreateOpsItemResult createOpsItem(CreateOpsItemRequest request)
AWSSimpleSystemsManagement
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.
createOpsItem
in interface AWSSimpleSystemsManagement
public CreateOpsMetadataResult createOpsMetadata(CreateOpsMetadataRequest request)
AWSSimpleSystemsManagement
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.
createOpsMetadata
in interface AWSSimpleSystemsManagement
public CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest request)
AWSSimpleSystemsManagement
Creates a patch baseline.
For information about valid key-value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaseline
in interface AWSSimpleSystemsManagement
public CreateResourceDataSyncResult createResourceDataSync(CreateResourceDataSyncRequest request)
AWSSimpleSystemsManagement
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems
Manager offers two types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3)
bucket. For more information, see Configuring
resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon
S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon
Web Services Regions or EntireOrganization
by using Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services
Systems Manager User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
createResourceDataSync
in interface AWSSimpleSystemsManagement
public DeleteActivationResult deleteActivation(DeleteActivationRequest request)
AWSSimpleSystemsManagement
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.
deleteActivation
in interface AWSSimpleSystemsManagement
public DeleteAssociationResult deleteAssociation(DeleteAssociationRequest request)
AWSSimpleSystemsManagement
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.
deleteAssociation
in interface AWSSimpleSystemsManagement
public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
AWSSimpleSystemsManagement
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.
deleteDocument
in interface AWSSimpleSystemsManagement
public DeleteInventoryResult deleteInventory(DeleteInventoryRequest request)
AWSSimpleSystemsManagement
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.
deleteInventory
in interface AWSSimpleSystemsManagement
public DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Deletes a maintenance window.
deleteMaintenanceWindow
in interface AWSSimpleSystemsManagement
public DeleteOpsItemResult deleteOpsItem(DeleteOpsItemRequest request)
AWSSimpleSystemsManagement
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.
deleteOpsItem
in interface AWSSimpleSystemsManagement
public DeleteOpsMetadataResult deleteOpsMetadata(DeleteOpsMetadataRequest request)
AWSSimpleSystemsManagement
Delete OpsMetadata related to an application.
deleteOpsMetadata
in interface AWSSimpleSystemsManagement
public DeleteParameterResult deleteParameter(DeleteParameterRequest request)
AWSSimpleSystemsManagement
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParameter
in interface AWSSimpleSystemsManagement
public DeleteParametersResult deleteParameters(DeleteParametersRequest request)
AWSSimpleSystemsManagement
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParameters
in interface AWSSimpleSystemsManagement
public DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest request)
AWSSimpleSystemsManagement
Deletes a patch baseline.
deletePatchBaseline
in interface AWSSimpleSystemsManagement
public DeleteResourceDataSyncResult deleteResourceDataSync(DeleteResourceDataSyncRequest request)
AWSSimpleSystemsManagement
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.
deleteResourceDataSync
in interface AWSSimpleSystemsManagement
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSSimpleSystemsManagement
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 for OpsItemGroup
enables 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.
deleteResourcePolicy
in interface AWSSimpleSystemsManagement
public DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest request)
AWSSimpleSystemsManagement
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstance
in interface AWSSimpleSystemsManagement
public DeregisterPatchBaselineForPatchGroupResult deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagement
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
public DeregisterTargetFromMaintenanceWindowResult deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindow
in interface AWSSimpleSystemsManagement
public DeregisterTaskFromMaintenanceWindowResult deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindow
in interface AWSSimpleSystemsManagement
public DescribeActivationsResult describeActivations(DescribeActivationsRequest request)
AWSSimpleSystemsManagement
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.
describeActivations
in interface AWSSimpleSystemsManagement
public DescribeAssociationResult describeAssociation(DescribeAssociationRequest request)
AWSSimpleSystemsManagement
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.
describeAssociation
in interface AWSSimpleSystemsManagement
public DescribeAssociationExecutionTargetsResult describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest request)
AWSSimpleSystemsManagement
Views information about a specific execution of a specific association.
describeAssociationExecutionTargets
in interface AWSSimpleSystemsManagement
public DescribeAssociationExecutionsResult describeAssociationExecutions(DescribeAssociationExecutionsRequest request)
AWSSimpleSystemsManagement
Views all executions for a specific association ID.
describeAssociationExecutions
in interface AWSSimpleSystemsManagement
public DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest request)
AWSSimpleSystemsManagement
Provides details about all active and terminated Automation executions.
describeAutomationExecutions
in interface AWSSimpleSystemsManagement
public DescribeAutomationStepExecutionsResult describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest request)
AWSSimpleSystemsManagement
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutions
in interface AWSSimpleSystemsManagement
public DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest request)
AWSSimpleSystemsManagement
Lists all patches eligible to be included in a patch baseline.
Currently, DescribeAvailablePatches
supports only the Amazon Linux 1, Amazon Linux 2, and Windows
Server operating systems.
describeAvailablePatches
in interface AWSSimpleSystemsManagement
public DescribeDocumentResult describeDocument(DescribeDocumentRequest request)
AWSSimpleSystemsManagement
Describes the specified Amazon Web Services Systems Manager document (SSM document).
describeDocument
in interface AWSSimpleSystemsManagement
public DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest request)
AWSSimpleSystemsManagement
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).
describeDocumentPermission
in interface AWSSimpleSystemsManagement
public DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest request)
AWSSimpleSystemsManagement
All associations for the managed nodes.
describeEffectiveInstanceAssociations
in interface AWSSimpleSystemsManagement
public DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest request)
AWSSimpleSystemsManagement
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
describeEffectivePatchesForPatchBaseline
in interface AWSSimpleSystemsManagement
public DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest request)
AWSSimpleSystemsManagement
The status of the associations for the managed nodes.
describeInstanceAssociationsStatus
in interface AWSSimpleSystemsManagement
public DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest request)
AWSSimpleSystemsManagement
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.
The IamRole
field returned for this API operation is the Identity and Access Management (IAM) role
assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.
describeInstanceInformation
in interface AWSSimpleSystemsManagement
public DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest request)
AWSSimpleSystemsManagement
Retrieves the high-level patch state of one or more managed nodes.
describeInstancePatchStates
in interface AWSSimpleSystemsManagement
public DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest request)
AWSSimpleSystemsManagement
Retrieves the high-level patch state for the managed nodes in the specified patch group.
describeInstancePatchStatesForPatchGroup
in interface AWSSimpleSystemsManagement
public DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest request)
AWSSimpleSystemsManagement
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
describeInstancePatches
in interface AWSSimpleSystemsManagement
public DescribeInstancePropertiesResult describeInstanceProperties(DescribeInstancePropertiesRequest request)
AWSSimpleSystemsManagement
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
describeInstanceProperties
in interface AWSSimpleSystemsManagement
public DescribeInventoryDeletionsResult describeInventoryDeletions(DescribeInventoryDeletionsRequest request)
AWSSimpleSystemsManagement
Describes a specific delete inventory operation.
describeInventoryDeletions
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowExecutionTaskInvocationsResult describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request)
AWSSimpleSystemsManagement
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocations
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request)
AWSSimpleSystemsManagement
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasks
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowExecutionsResult describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest request)
AWSSimpleSystemsManagement
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.
describeMaintenanceWindowExecutions
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowScheduleResult describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest request)
AWSSimpleSystemsManagement
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowSchedule
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request)
AWSSimpleSystemsManagement
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargets
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request)
AWSSimpleSystemsManagement
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values don't affect the running of your task and can be
ignored.
describeMaintenanceWindowTasks
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest request)
AWSSimpleSystemsManagement
Retrieves the maintenance windows in an Amazon Web Services account.
describeMaintenanceWindows
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowsForTargetResult describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest request)
AWSSimpleSystemsManagement
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
describeMaintenanceWindowsForTarget
in interface AWSSimpleSystemsManagement
public DescribeOpsItemsResult describeOpsItems(DescribeOpsItemsRequest request)
AWSSimpleSystemsManagement
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.
describeOpsItems
in interface AWSSimpleSystemsManagement
public DescribeParametersResult describeParameters(DescribeParametersRequest request)
AWSSimpleSystemsManagement
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.
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.
describeParameters
in interface AWSSimpleSystemsManagement
public DescribePatchBaselinesResult describePatchBaselines(DescribePatchBaselinesRequest request)
AWSSimpleSystemsManagement
Lists the patch baselines in your Amazon Web Services account.
describePatchBaselines
in interface AWSSimpleSystemsManagement
public DescribePatchGroupStateResult describePatchGroupState(DescribePatchGroupStateRequest request)
AWSSimpleSystemsManagement
Returns high-level aggregated patch compliance state information for a patch group.
describePatchGroupState
in interface AWSSimpleSystemsManagement
public DescribePatchGroupsResult describePatchGroups(DescribePatchGroupsRequest request)
AWSSimpleSystemsManagement
Lists all patch groups that have been registered with patch baselines.
describePatchGroups
in interface AWSSimpleSystemsManagement
public DescribePatchPropertiesResult describePatchProperties(DescribePatchPropertiesRequest request)
AWSSimpleSystemsManagement
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:
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| PRIORITY
Valid properties: PRODUCT
| CLASSIFICATION
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| PRIORITY
Valid properties: PRODUCT
| PRODUCT_FAMILY
| CLASSIFICATION
|
MSRC_SEVERITY
describePatchProperties
in interface AWSSimpleSystemsManagement
public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)
AWSSimpleSystemsManagement
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessions
in interface AWSSimpleSystemsManagement
public DisassociateOpsItemRelatedItemResult disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest request)
AWSSimpleSystemsManagement
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
disassociateOpsItemRelatedItem
in interface AWSSimpleSystemsManagement
public GetAutomationExecutionResult getAutomationExecution(GetAutomationExecutionRequest request)
AWSSimpleSystemsManagement
Get detailed information about a particular Automation execution.
getAutomationExecution
in interface AWSSimpleSystemsManagement
public GetCalendarStateResult getCalendarState(GetCalendarStateRequest request)
AWSSimpleSystemsManagement
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
If you specify a time, GetCalendarState
returns the state of the calendar at that specific time, and
returns the next time that the change calendar state will transition. If you don't specify a time,
GetCalendarState
uses the current time. Change Calendar entries have two possible states:
OPEN
or CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
getCalendarState
in interface AWSSimpleSystemsManagement
public GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest request)
AWSSimpleSystemsManagement
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command
execution status on a specific managed node, use ListCommandInvocations. To get the command execution
status across managed nodes, use ListCommands.
getCommandInvocation
in interface AWSSimpleSystemsManagement
public GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest request)
AWSSimpleSystemsManagement
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatus
in interface AWSSimpleSystemsManagement
public GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest request)
AWSSimpleSystemsManagement
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.
getDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
public GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest request)
AWSSimpleSystemsManagement
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).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your
local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the
Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems
Manager, with an SSM document that enables you to target a managed node with a script or command. For example,
run the command using the AWS-RunShellScript
document or the AWS-RunPowerShellScript
document.
getDeployablePatchSnapshotForInstance
in interface AWSSimpleSystemsManagement
public GetDocumentResult getDocument(GetDocumentRequest request)
AWSSimpleSystemsManagement
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
getDocument
in interface AWSSimpleSystemsManagement
public GetInventoryResult getInventory(GetInventoryRequest request)
AWSSimpleSystemsManagement
Query inventory information. This includes managed node status, such as Stopped
or
Terminated
.
getInventory
in interface AWSSimpleSystemsManagement
public GetInventorySchemaResult getInventorySchema(GetInventorySchemaRequest request)
AWSSimpleSystemsManagement
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchema
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowResult getMaintenanceWindow(GetMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Retrieves a maintenance window.
getMaintenanceWindow
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request)
AWSSimpleSystemsManagement
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request)
AWSSimpleSystemsManagement
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTask
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest request)
AWSSimpleSystemsManagement
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocation
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request)
AWSSimpleSystemsManagement
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values don't affect the running of your task and can be
ignored.
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
getMaintenanceWindowTask
in interface AWSSimpleSystemsManagement
public GetOpsItemResult getOpsItem(GetOpsItemRequest request)
AWSSimpleSystemsManagement
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.
getOpsItem
in interface AWSSimpleSystemsManagement
public GetOpsMetadataResult getOpsMetadata(GetOpsMetadataRequest request)
AWSSimpleSystemsManagement
View operational metadata related to an application in Application Manager.
getOpsMetadata
in interface AWSSimpleSystemsManagement
public GetOpsSummaryResult getOpsSummary(GetOpsSummaryRequest request)
AWSSimpleSystemsManagement
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.
getOpsSummary
in interface AWSSimpleSystemsManagement
public GetParameterResult getParameter(GetParameterRequest request)
AWSSimpleSystemsManagement
Get information about a single parameter by specifying the parameter name.
To get information about more than one parameter at a time, use the GetParameters operation.
getParameter
in interface AWSSimpleSystemsManagement
public GetParameterHistoryResult getParameterHistory(GetParameterHistoryRequest request)
AWSSimpleSystemsManagement
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, GetParameterHistory
retrieves whatever the
original key alias was referencing.
getParameterHistory
in interface AWSSimpleSystemsManagement
public GetParametersResult getParameters(GetParametersRequest request)
AWSSimpleSystemsManagement
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
getParameters
in interface AWSSimpleSystemsManagement
public GetParametersByPathResult getParametersByPath(GetParametersByPathRequest request)
AWSSimpleSystemsManagement
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
getParametersByPath
in interface AWSSimpleSystemsManagement
public GetPatchBaselineResult getPatchBaseline(GetPatchBaselineRequest request)
AWSSimpleSystemsManagement
Retrieves information about a patch baseline.
getPatchBaseline
in interface AWSSimpleSystemsManagement
public GetPatchBaselineForPatchGroupResult getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagement
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
public GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest request)
AWSSimpleSystemsManagement
Returns an array of the Policy
object.
getResourcePolicies
in interface AWSSimpleSystemsManagement
public GetServiceSettingResult getServiceSetting(GetServiceSettingRequest request)
AWSSimpleSystemsManagement
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.
getServiceSetting
in interface AWSSimpleSystemsManagement
request
- The request body of the GetServiceSetting API operation.public LabelParameterVersionResult labelParameterVersion(LabelParameterVersionRequest request)
AWSSimpleSystemsManagement
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.
labelParameterVersion
in interface AWSSimpleSystemsManagement
public ListAssociationVersionsResult listAssociationVersions(ListAssociationVersionsRequest request)
AWSSimpleSystemsManagement
Retrieves all versions of an association for a specific association ID.
listAssociationVersions
in interface AWSSimpleSystemsManagement
public ListAssociationsResult listAssociations(ListAssociationsRequest request)
AWSSimpleSystemsManagement
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
listAssociations
in interface AWSSimpleSystemsManagement
public ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest request)
AWSSimpleSystemsManagement
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.
listCommandInvocations
in interface AWSSimpleSystemsManagement
public ListCommandsResult listCommands(ListCommandsRequest request)
AWSSimpleSystemsManagement
Lists the commands requested by users of the Amazon Web Services account.
listCommands
in interface AWSSimpleSystemsManagement
public ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest request)
AWSSimpleSystemsManagement
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.
listComplianceItems
in interface AWSSimpleSystemsManagement
public ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest request)
AWSSimpleSystemsManagement
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.
listComplianceSummaries
in interface AWSSimpleSystemsManagement
public ListDocumentMetadataHistoryResult listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest request)
AWSSimpleSystemsManagement
Information about approval reviews for a version of a change template in Change Manager.
listDocumentMetadataHistory
in interface AWSSimpleSystemsManagement
public ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest request)
AWSSimpleSystemsManagement
List all versions for a document.
listDocumentVersions
in interface AWSSimpleSystemsManagement
public ListDocumentsResult listDocuments(ListDocumentsRequest request)
AWSSimpleSystemsManagement
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.
listDocuments
in interface AWSSimpleSystemsManagement
public ListDocumentsResult listDocuments()
AWSSimpleSystemsManagement
listDocuments
in interface AWSSimpleSystemsManagement
AWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)
public ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest request)
AWSSimpleSystemsManagement
A list of inventory items returned by the request.
listInventoryEntries
in interface AWSSimpleSystemsManagement
public ListOpsItemEventsResult listOpsItemEvents(ListOpsItemEventsRequest request)
AWSSimpleSystemsManagement
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.
listOpsItemEvents
in interface AWSSimpleSystemsManagement
public ListOpsItemRelatedItemsResult listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest request)
AWSSimpleSystemsManagement
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
listOpsItemRelatedItems
in interface AWSSimpleSystemsManagement
public ListOpsMetadataResult listOpsMetadata(ListOpsMetadataRequest request)
AWSSimpleSystemsManagement
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadata
in interface AWSSimpleSystemsManagement
public ListResourceComplianceSummariesResult listResourceComplianceSummaries(ListResourceComplianceSummariesRequest request)
AWSSimpleSystemsManagement
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.
listResourceComplianceSummaries
in interface AWSSimpleSystemsManagement
public ListResourceDataSyncResult listResourceDataSync(ListResourceDataSyncRequest request)
AWSSimpleSystemsManagement
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.
listResourceDataSync
in interface AWSSimpleSystemsManagement
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSimpleSystemsManagement
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
listTagsForResource
in interface AWSSimpleSystemsManagement
public ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest request)
AWSSimpleSystemsManagement
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.
modifyDocumentPermission
in interface AWSSimpleSystemsManagement
public PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest request)
AWSSimpleSystemsManagement
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, Critical
.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline
.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify
the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItems
in interface AWSSimpleSystemsManagement
public PutInventoryResult putInventory(PutInventoryRequest request)
AWSSimpleSystemsManagement
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.
putInventory
in interface AWSSimpleSystemsManagement
public PutParameterResult putParameter(PutParameterRequest request)
AWSSimpleSystemsManagement
Add a parameter to the system.
putParameter
in interface AWSSimpleSystemsManagement
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSSimpleSystemsManagement
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 for OpsItemGroup
enables 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 SecureString
parameter, 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 PutResourcePolicy
operation, we recommend
using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy
requires 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 --shared
option.
For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide
putResourcePolicy
in interface AWSSimpleSystemsManagement
public RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request)
AWSSimpleSystemsManagement
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
.
registerDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
public RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagement
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
public RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
public RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AWSSimpleSystemsManagement
Removes tag keys from the specified resource.
removeTagsFromResource
in interface AWSSimpleSystemsManagement
public ResetServiceSettingResult resetServiceSetting(ResetServiceSettingRequest request)
AWSSimpleSystemsManagement
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.
resetServiceSetting
in interface AWSSimpleSystemsManagement
request
- The request body of the ResetServiceSetting API operation.public ResumeSessionResult resumeSession(ResumeSessionRequest request)
AWSSimpleSystemsManagement
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.
resumeSession
in interface AWSSimpleSystemsManagement
public SendAutomationSignalResult sendAutomationSignal(SendAutomationSignalRequest request)
AWSSimpleSystemsManagement
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignal
in interface AWSSimpleSystemsManagement
public SendCommandResult sendCommand(SendCommandRequest request)
AWSSimpleSystemsManagement
Runs commands on one or more managed nodes.
sendCommand
in interface AWSSimpleSystemsManagement
public StartAssociationsOnceResult startAssociationsOnce(StartAssociationsOnceRequest request)
AWSSimpleSystemsManagement
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
startAssociationsOnce
in interface AWSSimpleSystemsManagement
public StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest request)
AWSSimpleSystemsManagement
Initiates execution of an Automation runbook.
startAutomationExecution
in interface AWSSimpleSystemsManagement
public StartChangeRequestExecutionResult startChangeRequestExecution(StartChangeRequestExecutionRequest request)
AWSSimpleSystemsManagement
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.
startChangeRequestExecution
in interface AWSSimpleSystemsManagement
public StartSessionResult startSession(StartSessionRequest request)
AWSSimpleSystemsManagement
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.
Amazon Web Services CLI usage: start-session
is an interactive command that requires the Session
Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems
Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
startSession
in interface AWSSimpleSystemsManagement
public StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest request)
AWSSimpleSystemsManagement
Stop an Automation that is currently running.
stopAutomationExecution
in interface AWSSimpleSystemsManagement
public TerminateSessionResult terminateSession(TerminateSessionRequest request)
AWSSimpleSystemsManagement
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.
terminateSession
in interface AWSSimpleSystemsManagement
public UnlabelParameterVersionResult unlabelParameterVersion(UnlabelParameterVersionRequest request)
AWSSimpleSystemsManagement
Remove a label or labels from a parameter.
unlabelParameterVersion
in interface AWSSimpleSystemsManagement
public UpdateAssociationResult updateAssociation(UpdateAssociationRequest request)
AWSSimpleSystemsManagement
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.
updateAssociation
in interface AWSSimpleSystemsManagement
public UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest request)
AWSSimpleSystemsManagement
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.
updateAssociationStatus
in interface AWSSimpleSystemsManagement
public UpdateDocumentResult updateDocument(UpdateDocumentRequest request)
AWSSimpleSystemsManagement
Updates one or more values for an SSM document.
updateDocument
in interface AWSSimpleSystemsManagement
public UpdateDocumentDefaultVersionResult updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest request)
AWSSimpleSystemsManagement
Set the default version of a document.
If you change a document version for a State Manager association, Systems Manager immediately runs the
association unless you previously specifed the apply-only-at-cron-interval
parameter.
updateDocumentDefaultVersion
in interface AWSSimpleSystemsManagement
public UpdateDocumentMetadataResult updateDocumentMetadata(UpdateDocumentMetadataRequest request)
AWSSimpleSystemsManagement
Updates information related to approval reviews for a specific version of a change template in Change Manager.
updateDocumentMetadata
in interface AWSSimpleSystemsManagement
public UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Updates an existing maintenance window. Only specified parameters are modified.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
updateMaintenanceWindow
in interface AWSSimpleSystemsManagement
public UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest request)
AWSSimpleSystemsManagement
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.
If a parameter is null, then the corresponding field isn't modified.
updateMaintenanceWindowTarget
in interface AWSSimpleSystemsManagement
public UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest request)
AWSSimpleSystemsManagement
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN
. For example, you can change a RUN_COMMAND
task from
AWS-RunPowerShellScript
to AWS-RunShellScript
.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
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.
updateMaintenanceWindowTask
in interface AWSSimpleSystemsManagement
public UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request)
AWSSimpleSystemsManagement
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.
updateManagedInstanceRole
in interface AWSSimpleSystemsManagement
public UpdateOpsItemResult updateOpsItem(UpdateOpsItemRequest request)
AWSSimpleSystemsManagement
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.
updateOpsItem
in interface AWSSimpleSystemsManagement
public UpdateOpsMetadataResult updateOpsMetadata(UpdateOpsMetadataRequest request)
AWSSimpleSystemsManagement
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
updateOpsMetadata
in interface AWSSimpleSystemsManagement
public UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest request)
AWSSimpleSystemsManagement
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key-value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
updatePatchBaseline
in interface AWSSimpleSystemsManagement
public UpdateResourceDataSyncResult updateResourceDataSync(UpdateResourceDataSyncRequest request)
AWSSimpleSystemsManagement
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.
This API operation only supports a resource data sync that was created with a SyncFromSource
SyncType
.
updateResourceDataSync
in interface AWSSimpleSystemsManagement
public UpdateServiceSettingResult updateServiceSetting(UpdateServiceSettingRequest request)
AWSSimpleSystemsManagement
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.
updateServiceSetting
in interface AWSSimpleSystemsManagement
request
- The request body of the UpdateServiceSetting API operation.public void shutdown()
AWSSimpleSystemsManagement
shutdown
in interface AWSSimpleSystemsManagement
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSimpleSystemsManagement
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSSimpleSystemsManagement
request
- The originally executed request.public AWSSimpleSystemsManagementWaiters waiters()
waiters
in interface AWSSimpleSystemsManagement