@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSimpleSystemsManagement
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSimpleSystemsManagement instead.
AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any on-premises server or virtual machine (VM) in your hybrid environment that has been configured for Systems Manager.
This reference is intended to be used with the AWS Systems Manager User Guide.
To get started, verify prerequisites and configure managed instances. For more information, see Setting up AWS Systems Manager in the AWS Systems Manager User Guide.
For information about other API actions you can perform on EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API requests.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource.
|
CancelCommandResult |
cancelCommand(CancelCommandRequest cancelCommandRequest)
Attempts to cancel the command specified by the Command ID.
|
CancelMaintenanceWindowExecutionResult |
cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have
not already starting running.
|
CreateActivationResult |
createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine
(VM) with Systems Manager.
|
CreateAssociationResult |
createAssociation(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your instances.
|
CreateAssociationBatchResult |
createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
|
CreateDocumentResult |
createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager (SSM) document.
|
CreateMaintenanceWindowResult |
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new maintenance window.
|
CreateOpsItemResult |
createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem.
|
CreatePatchBaselineResult |
createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
|
CreateResourceDataSyncResult |
createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location.
|
DeleteActivationResult |
deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation.
|
DeleteAssociationResult |
deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
|
DeleteInventoryResult |
deleteInventory(DeleteInventoryRequest deleteInventoryRequest)
Delete a custom inventory type or the data associated with a custom Inventory type.
|
DeleteMaintenanceWindowResult |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a maintenance window.
|
DeleteParameterResult |
deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
|
DeleteParametersResult |
deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.
|
DeletePatchBaselineResult |
deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
|
DeleteResourceDataSyncResult |
deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration.
|
DeregisterManagedInstanceResult |
deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers.
|
DeregisterPatchBaselineForPatchGroupResult |
deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
|
DeregisterTargetFromMaintenanceWindowResult |
deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a maintenance window.
|
DeregisterTaskFromMaintenanceWindowResult |
deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a maintenance window.
|
DescribeActivationsResult |
describeActivations(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the IAM role assigned to the instances in the activation, and the number of instances registered by using
this activation.
|
DescribeAssociationResult |
describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or instance.
|
DescribeAssociationExecutionsResult |
describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
|
DescribeAssociationExecutionTargetsResult |
describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
|
DescribeAutomationExecutionsResult |
describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
|
DescribeAutomationStepExecutionsResult |
describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
|
DescribeAvailablePatchesResult |
describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
|
DescribeDocumentResult |
describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Systems Manager document.
|
DescribeDocumentPermissionResult |
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document.
|
DescribeEffectiveInstanceAssociationsResult |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
|
DescribeEffectivePatchesForPatchBaselineResult |
describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
DescribeInstanceAssociationsStatusResult |
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
|
DescribeInstanceInformationResult |
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version
of SSM Agent installed on the instance, instance status, and so on.
|
DescribeInstancePatchesResult |
describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline
being used for the instance.
|
DescribeInstancePatchStatesResult |
describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
|
DescribeInstancePatchStatesForPatchGroupResult |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
|
DescribeInventoryDeletionsResult |
describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
|
DescribeMaintenanceWindowExecutionsResult |
describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
Lists the executions of a maintenance window.
|
DescribeMaintenanceWindowExecutionTaskInvocationsResult |
describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
DescribeMaintenanceWindowExecutionTasksResult |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
|
DescribeMaintenanceWindowsResult |
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
|
DescribeMaintenanceWindowScheduleResult |
describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
|
DescribeMaintenanceWindowsForTargetResult |
describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
|
DescribeMaintenanceWindowTargetsResult |
describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
|
DescribeMaintenanceWindowTasksResult |
describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
|
DescribeOpsItemsResult |
describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems.
|
DescribeParametersResult |
describeParameters(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
|
DescribePatchBaselinesResult |
describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
|
DescribePatchGroupsResult |
describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
|
DescribePatchGroupStateResult |
describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
|
DescribePatchPropertiesResult |
describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
DescribeSessionsResult |
describeSessions(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
GetAutomationExecutionResult |
getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
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 getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time.
|
GetCommandInvocationResult |
getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
|
GetConnectionStatusResult |
getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to
receive Session Manager connections.
|
GetDefaultPatchBaselineResult |
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline.
|
GetDeployablePatchSnapshotForInstanceResult |
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses.
|
GetDocumentResult |
getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Systems Manager document.
|
GetInventoryResult |
getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
|
GetInventorySchemaResult |
getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest)
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 getMaintenanceWindowRequest)
Retrieves a maintenance window.
|
GetMaintenanceWindowExecutionResult |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
|
GetMaintenanceWindowExecutionTaskResult |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
|
GetMaintenanceWindowExecutionTaskInvocationResult |
getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
|
GetMaintenanceWindowTaskResult |
getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a maintenance window.
|
GetOpsItemResult |
getOpsItem(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID.
|
GetOpsSummaryResult |
getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
|
GetParameterResult |
getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name.
|
GetParameterHistoryResult |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
|
GetParametersResult |
getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter.
|
GetParametersByPathResult |
getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
Retrieve information about one or more parameters in a specific hierarchy.
|
GetPatchBaselineResult |
getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
|
GetPatchBaselineForPatchGroupResult |
getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
|
GetServiceSettingResult |
getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
LabelParameterVersionResult |
labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter.
|
ListAssociationsResult |
listAssociations(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region.
|
ListAssociationVersionsResult |
listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
|
ListCommandInvocationsResult |
listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance.
|
ListCommandsResult |
listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
|
ListComplianceItemsResult |
listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types.
|
ListComplianceSummariesResult |
listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
ListDocumentsResult |
listDocuments()
Simplified method form for invoking the ListDocuments operation.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region.
|
ListDocumentVersionsResult |
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
ListInventoryEntriesResult |
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
ListResourceComplianceSummariesResult |
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
Returns a resource-level summary count.
|
ListResourceDataSyncResult |
listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
Lists your resource data sync configurations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
|
ModifyDocumentPermissionResult |
modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately.
|
PutComplianceItemsResult |
putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource.
|
PutInventoryResult |
putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance.
|
PutParameterResult |
putParameter(PutParameterRequest putParameterRequest)
Add a parameter to the system.
|
RegisterDefaultPatchBaselineResult |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
|
RegisterPatchBaselineForPatchGroupResult |
registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
|
RegisterTargetWithMaintenanceWindowResult |
registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a maintenance window.
|
RegisterTaskWithMaintenanceWindowResult |
registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a maintenance window.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
|
ResetServiceSettingResult |
resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
ResumeSessionResult |
resumeSession(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to an instance after it has been disconnected.
|
SendAutomationSignalResult |
sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
SendCommandResult |
sendCommand(SendCommandRequest sendCommandRequest)
Runs commands on one or more managed instances.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAssociationsOnceResult |
startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time.
|
StartAutomationExecutionResult |
startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
|
StartSessionResult |
startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session.
|
StopAutomationExecutionResult |
stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently running.
|
TerminateSessionResult |
terminateSession(TerminateSessionRequest terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the
instance.
|
UpdateAssociationResult |
updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association.
|
UpdateAssociationStatusResult |
updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
|
UpdateDocumentResult |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates one or more values for an SSM document.
|
UpdateDocumentDefaultVersionResult |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
UpdateMaintenanceWindowResult |
updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
Updates an existing maintenance window.
|
UpdateMaintenanceWindowTargetResult |
updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
Modifies the target of an existing maintenance window.
|
UpdateMaintenanceWindowTaskResult |
updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a maintenance window.
|
UpdateManagedInstanceRoleResult |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or
virtual machines (VM).
|
UpdateOpsItemResult |
updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
Edit or change an OpsItem.
|
UpdatePatchBaselineResult |
updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline.
|
UpdateResourceDataSyncResult |
updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)
Update a resource data sync.
|
UpdateServiceSettingResult |
updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. |
AWSSimpleSystemsManagementWaiters |
waiters() |
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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)AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with EC2 instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.TooManyTagsErrorException - The Targets parameter includes too many tags. Remove one or more tags and try the command
again.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.CancelCommandResult cancelCommand(CancelCommandRequest cancelCommandRequest)
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.
cancelCommandRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.CancelMaintenanceWindowExecutionResult cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
cancelMaintenanceWindowExecutionRequest - InternalServerErrorException - An error occurred on the server side.DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
CreateActivationResult createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises server or virtual machine (VM) with Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises instances and VMs using Systems Manager, see Setting up AWS Systems Manager for hybrid environments in the AWS Systems Manager User Guide.
On-premises servers or VMs that are registered with Systems Manager and EC2 instances that you manage with Systems Manager are all called managed instances.
createActivationRequest - InternalServerErrorException - An error occurred on the server side.CreateAssociationResult createAssociation(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your instances. For example, an association can specify that anti-virus software must be installed and running on your instances, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an AWS Resource Group or an AWS Autoscaling Group, State Manager applies the configuration when new instances are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software is not installed, then State Manager installs it. If the software is installed, but the service is not running, then the association might instruct State Manager to start the service.
createAssociationRequest - AssociationAlreadyExistsException - The specified association already exists.AssociationLimitExceededException - You can have at most 2,000 active associations.InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidTargetException - The target is not valid or does not exist. It might not be configured for Systems Manager or you might
not have permission to perform the operation.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatchRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.AssociationLimitExceededException - You can have at most 2,000 active associations.UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidTargetException - The target is not valid or does not exist. It might not be configured for Systems Manager or you might
not have permission to perform the operation.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.CreateDocumentResult createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Systems Manager (SSM) document. An SSM document defines the actions that Systems Manager performs on your managed instances. For more information about SSM documents, including information about supported schemas, features, and syntax, see AWS Systems Manager Documents in the AWS Systems Manager User Guide.
createDocumentRequest - DocumentAlreadyExistsException - The specified document already exists.MaxDocumentSizeExceededException - The size limit of a document is 64 KB.InternalServerErrorException - An error occurred on the server side.InvalidDocumentContentException - The content for the document is not valid.DocumentLimitExceededException - You can have at most 500 active Systems Manager documents.InvalidDocumentSchemaVersionException - The version of the document schema is not supported.CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
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.
createMaintenanceWindowRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.CreateOpsItemResult createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
createOpsItemRequest - InternalServerErrorException - An error occurred on the server side.OpsItemAlreadyExistsException - The OpsItem already exists.OpsItemLimitExceededException - The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException - A specified parameter argument isn't valid. Verify the available arguments and try again.CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters for each supported operating system
type, see PatchFilter.
createPatchBaselineRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.CreateResourceDataSyncResult createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)
A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two
types of resource data sync: SyncToDestination and SyncFromSource.
You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize
Inventory data from multiple AWS Regions to a single S3 bucket. For more information, see Configuring
Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single S3 bucket. This type
can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization by
using AWS Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager
User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
createResourceDataSyncRequest - InternalServerErrorException - An error occurred on the server side.ResourceDataSyncCountExceededException - You have exceeded the allowed maximum sync configurations.ResourceDataSyncAlreadyExistsException - A sync configuration with the same name already exists.ResourceDataSyncInvalidConfigurationException - The specified sync configuration is invalid.DeleteActivationResult deleteActivation(DeleteActivationRequest deleteActivationRequest)
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
deleteActivationRequest - InvalidActivationIdException - The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try
again.InvalidActivationException - The activation is not valid. The activation might have been deleted, or the ActivationId and the
ActivationCode do not match.InternalServerErrorException - An error occurred on the server side.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.DeleteAssociationResult deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
deleteAssociationRequest - AssociationDoesNotExistException - The specified association does not exist.InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.DeleteDocumentResult deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
deleteDocumentRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentOperationException - You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.AssociatedInstancesException - You must disassociate a document from all instances before you can delete it.DeleteInventoryResult deleteInventory(DeleteInventoryRequest deleteInventoryRequest)
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.
deleteInventoryRequest - InternalServerErrorException - An error occurred on the server side.InvalidTypeNameException - The parameter type name is not valid.InvalidOptionException - The delete inventory option specified is not valid. Verify the option and try again.InvalidDeleteInventoryParametersException - One or more of the parameters specified for the delete operation is not valid. Verify all parameters and
try again.InvalidInventoryRequestException - The request is not valid.DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a maintenance window.
deleteMaintenanceWindowRequest - InternalServerErrorException - An error occurred on the server side.DeleteParameterResult deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system.
deleteParameterRequest - InternalServerErrorException - An error occurred on the server side.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.DeleteParametersResult deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters.
deleteParametersRequest - InternalServerErrorException - An error occurred on the server side.DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest deletePatchBaselineRequest)
Deletes a patch baseline.
deletePatchBaselineRequest - ResourceInUseException - Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.InternalServerErrorException - An error occurred on the server side.DeleteResourceDataSyncResult deleteResourceDataSync(DeleteResourceDataSyncRequest deleteResourceDataSyncRequest)
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to data on managed instances are no longer synced to or from the target. Deleting a sync configuration does not delete data.
deleteResourceDataSyncRequest - InternalServerErrorException - An error occurred on the server side.ResourceDataSyncNotFoundException - The specified sync name was not found.ResourceDataSyncInvalidConfigurationException - The specified sync configuration is invalid.DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstanceRequest - InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InternalServerErrorException - An error occurred on the server side.DeregisterPatchBaselineForPatchGroupResult deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest deregisterPatchBaselineForPatchGroupRequest)
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroupRequest - InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.DeregisterTargetFromMaintenanceWindowResult deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest deregisterTargetFromMaintenanceWindowRequest)
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.TargetInUseException - You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but
the target is still referenced in a task.DeregisterTaskFromMaintenanceWindowResult deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest deregisterTaskFromMaintenanceWindowRequest)
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.DescribeActivationsResult describeActivations(DescribeActivationsRequest describeActivationsRequest)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
describeActivationsRequest - InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or instance. If you created the association by using the
Targets parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
describeAssociationRequest - AssociationDoesNotExistException - The specified association does not exist.InvalidAssociationVersionException - The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST parameter to view the
latest version of the association.InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
DescribeAssociationExecutionTargetsResult describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Use this API action to view information about a specific execution of a specific association.
describeAssociationExecutionTargetsRequest - InternalServerErrorException - An error occurred on the server side.AssociationDoesNotExistException - The specified association does not exist.InvalidNextTokenException - The specified token is not valid.AssociationExecutionDoesNotExistException - The specified execution ID does not exist. Verify the ID number and try again.DescribeAssociationExecutionsResult describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Use this API action to view all executions for a specific association ID.
describeAssociationExecutionsRequest - InternalServerErrorException - An error occurred on the server side.AssociationDoesNotExistException - The specified association does not exist.InvalidNextTokenException - The specified token is not valid.DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest - InvalidFilterKeyException - The specified key is not valid.InvalidFilterValueException - The filter value is not valid. Verify the value and try again.InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.DescribeAutomationStepExecutionsResult describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest describeAutomationStepExecutionsRequest)
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutionsRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InvalidNextTokenException - The specified token is not valid.InvalidFilterKeyException - The specified key is not valid.InvalidFilterValueException - The filter value is not valid. Verify the value and try again.InternalServerErrorException - An error occurred on the server side.DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)
Lists all patches eligible to be included in a patch baseline.
describeAvailablePatchesRequest - InternalServerErrorException - An error occurred on the server side.DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Systems Manager document.
describeDocumentRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
describeDocumentPermissionRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidPermissionTypeException - The permission type is not supported. Share is the only supported permission type.DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the instance(s).
describeEffectiveInstanceAssociationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeEffectivePatchesForPatchBaselineRequest - InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
UnsupportedOperatingSystemException - The operating systems you specified is not supported, or the operation is not supported for the operating
system.InternalServerErrorException - An error occurred on the server side.DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the instance(s).
describeInstanceAssociationsStatusRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Describes one or more of your instances, including information about the operating system platform, the version of SSM Agent installed on the instance, instance status, and so on.
If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for EC2 instances.
describeInstanceInformationRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidNextTokenException - The specified token is not valid.InvalidInstanceInformationFilterValueException - The specified filter value is not valid.InvalidFilterKeyException - The specified key is not valid.DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStatesRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the instances in the specified patch group.
describeInstancePatchStatesForPatchGroupRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatchesRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.DescribeInventoryDeletionsResult describeInventoryDeletions(DescribeInventoryDeletionsRequest describeInventoryDeletionsRequest)
Describes a specific delete inventory operation.
describeInventoryDeletionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidDeletionIdException - The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.InvalidNextTokenException - The specified token is not valid.DescribeMaintenanceWindowExecutionTaskInvocationsResult describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest describeMaintenanceWindowExecutionTaskInvocationsRequest)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocationsRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest describeMaintenanceWindowExecutionTasksRequest)
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasksRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowExecutionsResult describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)
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.
describeMaintenanceWindowExecutionsRequest - InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowScheduleResult describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest describeMaintenanceWindowScheduleRequest)
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowScheduleRequest - InternalServerErrorException - An error occurred on the server side.DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest describeMaintenanceWindowTargetsRequest)
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargetsRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
describeMaintenanceWindowTasksRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindowsRequest - InternalServerErrorException - An error occurred on the server side.DescribeMaintenanceWindowsForTargetResult describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowsForTargetRequest - InternalServerErrorException - An error occurred on the server side.DescribeOpsItemsResult describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
describeOpsItemsRequest - InternalServerErrorException - An error occurred on the server side.DescribeParametersResult describeParameters(DescribeParametersRequest describeParametersRequest)
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken.
You can specify the NextToken in a subsequent call to get the next set of results.
describeParametersRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterKeyException - The specified key is not valid.InvalidFilterOptionException - The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException - The filter value is not valid. Verify the value and try again.InvalidNextTokenException - The specified token is not valid.DescribePatchBaselinesResult describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your AWS account.
describePatchBaselinesRequest - InternalServerErrorException - An error occurred on the server side.DescribePatchGroupStateResult describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupStateRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.DescribePatchGroupsResult describePatchGroups(DescribePatchGroupsRequest describePatchGroupsRequest)
Lists all patch groups that have been registered with patch baselines.
describePatchGroupsRequest - InternalServerErrorException - An error occurred on the server side.DescribePatchPropertiesResult describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
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
describePatchPropertiesRequest - InternalServerErrorException - An error occurred on the server side.DescribeSessionsResult describeSessions(DescribeSessionsRequest describeSessionsRequest)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterKeyException - The specified key is not valid.InvalidNextTokenException - The specified token is not valid.GetAutomationExecutionResult getAutomationExecution(GetAutomationExecutionRequest getAutomationExecutionRequest)
Get detailed information about a particular Automation execution.
getAutomationExecutionRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InternalServerErrorException - An error occurred on the server side.GetCalendarStateResult getCalendarState(GetCalendarStateRequest getCalendarStateRequest)
Gets the state of the AWS Systems Manager Change Calendar at an optional, specified time. If you specify a time,
GetCalendarState returns the state of the calendar at a specific time, and returns the next time
that the Change Calendar state will transition. If you do not specify a time, GetCalendarState
assumes the current time. Change Calendar entries have two possible states: OPEN or
CLOSED.
If you specify more than one calendar in a request, the command returns the status of OPEN only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED.
For more information about Systems Manager Change Calendar, see AWS Systems Manager Change Calendar in the AWS Systems Manager User Guide.
getCalendarStateRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentTypeException - The document type is not valid. Valid document types are described in the DocumentType
property.UnsupportedCalendarException - The calendar entry contained in the specified Systems Manager document is not supported.GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocationRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidPluginNameException - The plugin name is not valid.InvocationDoesNotExistException - The command ID and instance ID you specified did not match any invocations. Verify the command ID and the
instance ID and try again.GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)
Retrieves the Session Manager connection status for an instance to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatusRequest - InternalServerErrorException - An error occurred on the server side.GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineRequest - InternalServerErrorException - An error occurred on the server side.GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstanceRequest - InternalServerErrorException - An error occurred on the server side.UnsupportedOperatingSystemException - The operating systems you specified is not supported, or the operation is not supported for the operating
system.UnsupportedFeatureRequiredException - Microsoft application patching is only available on EC2 instances and advanced instances. To patch
Microsoft applications on on-premises servers and VMs, you must enable advanced instances. For more
information, see Using the advanced-instances tier in the AWS Systems Manager User Guide.GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Systems Manager document.
getDocumentRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.GetInventoryResult getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information.
getInventoryRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException - The specified inventory group is not valid.InvalidNextTokenException - The specified token is not valid.InvalidTypeNameException - The parameter type name is not valid.InvalidAggregatorException - The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application or AWS:InstanceInformation.InvalidResultAttributeException - The specified inventory item result attribute is not valid.GetInventorySchemaResult getInventorySchema(GetInventorySchemaRequest getInventorySchemaRequest)
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchemaRequest - InternalServerErrorException - An error occurred on the server side.InvalidTypeNameException - The parameter type name is not valid.InvalidNextTokenException - The specified token is not valid.GetMaintenanceWindowResult getMaintenanceWindow(GetMaintenanceWindowRequest getMaintenanceWindowRequest)
Retrieves a maintenance window.
getMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest getMaintenanceWindowExecutionRequest)
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecutionRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest getMaintenanceWindowExecutionTaskRequest)
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest getMaintenanceWindowExecutionTaskInvocationRequest)
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocationRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Lists the tasks in a maintenance window.
getMaintenanceWindowTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.GetOpsItemResult getOpsItem(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
getOpsItemRequest - InternalServerErrorException - An error occurred on the server side.OpsItemNotFoundException - The specified OpsItem ID doesn't exist. Verify the ID and try again.GetOpsSummaryResult getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of OpsItems based on specified filters and aggregators.
getOpsSummaryRequest - InternalServerErrorException - An error occurred on the server side.ResourceDataSyncNotFoundException - The specified sync name was not found.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InvalidTypeNameException - The parameter type name is not valid.InvalidAggregatorException - The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid
inventory type such as AWS:Application or AWS:InstanceInformation.GetParameterResult getParameter(GetParameterRequest getParameterRequest)
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameterRequest - InternalServerErrorException - An error occurred on the server side.InvalidKeyIdException - The query key ID is not valid.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.ParameterVersionNotFoundException - The specified parameter version was not found. Verify the parameter name and version, and try again.GetParameterHistoryResult getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Query a list of all parameters used by the AWS account.
getParameterHistoryRequest - InternalServerErrorException - An error occurred on the server side.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.InvalidNextTokenException - The specified token is not valid.InvalidKeyIdException - The query key ID is not valid.GetParametersResult getParameters(GetParametersRequest getParametersRequest)
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
getParametersRequest - InvalidKeyIdException - The query key ID is not valid.InternalServerErrorException - An error occurred on the server side.GetParametersByPathResult getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)
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.
getParametersByPathRequest - InternalServerErrorException - An error occurred on the server side.InvalidFilterKeyException - The specified key is not valid.InvalidFilterOptionException - The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException - The filter value is not valid. Verify the value and try again.InvalidKeyIdException - The query key ID is not valid.InvalidNextTokenException - The specified token is not valid.GetPatchBaselineResult getPatchBaseline(GetPatchBaselineRequest getPatchBaselineRequest)
Retrieves information about a patch baseline.
getPatchBaselineRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.GetPatchBaselineForPatchGroupResult getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest getPatchBaselineForPatchGroupRequest)
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroupRequest - InternalServerErrorException - An error occurred on the server side.GetServiceSettingResult getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for
a SettingId. You can't create a new SettingId, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
getServiceSettingRequest - The request body of the GetServiceSetting API action.InternalServerErrorException - An error occurred on the server side.ServiceSettingNotFoundException - The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.LabelParameterVersionResult labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
labelParameterVersionRequest - InternalServerErrorException - An error occurred on the server side.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.ParameterNotFoundException - The parameter could not be found. Verify the name and try again.ParameterVersionNotFoundException - The specified parameter version was not found. Verify the parameter name and version, and try again.ParameterVersionLabelLimitExceededException - A parameter version can have a maximum of ten labels.ListAssociationVersionsResult listAssociationVersions(ListAssociationVersionsRequest listAssociationVersionsRequest)
Retrieves all versions of an association for a specific association ID.
listAssociationVersionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.AssociationDoesNotExistException - The specified association does not exist.ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current AWS account and Region. You can limit the results to a specific State Manager association document or instance by specifying a filter.
listAssociationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
listCommandInvocationsRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKeyException - The specified key is not valid.InvalidNextTokenException - The specified token is not valid.ListCommandsResult listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the AWS account.
listCommandsRequest - InternalServerErrorException - An error occurred on the server side.InvalidCommandIdExceptionInvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidFilterKeyException - The specified key is not valid.InvalidNextTokenException - The specified token is not valid.ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItemsRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)
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.
listComplianceSummariesRequest - InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
listDocumentVersionsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.InvalidDocumentException - The specified document does not exist.ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current AWS account and Region. You can limit the results of this request by using a filter.
listDocumentsRequest - InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.InvalidFilterKeyException - The specified key is not valid.ListDocumentsResult listDocuments()
listDocuments(ListDocumentsRequest)ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
listInventoryEntriesRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException - The parameter type name is not valid.InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.ListResourceComplianceSummariesResult listResourceComplianceSummaries(ListResourceComplianceSummariesRequest listResourceComplianceSummariesRequest)
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.
listResourceComplianceSummariesRequest - InvalidFilterException - The filter name is not valid. Verify the you entered the correct name and try again.InvalidNextTokenException - The specified token is not valid.InternalServerErrorException - An error occurred on the server side.ListResourceDataSyncResult listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)
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.
listResourceDataSyncRequest - ResourceDataSyncInvalidConfigurationException - The specified sync configuration is invalid.InternalServerErrorException - An error occurred on the server side.InvalidNextTokenException - The specified token is not valid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
listTagsForResourceRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)
Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermissionRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidPermissionTypeException - The permission type is not supported. Share is the only supported permission type.DocumentPermissionLimitException - The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20
accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS
Support.DocumentLimitExceededException - You can have at most 500 active Systems Manager documents.PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved for patches, or Failed
for associations.
Severity: A patch severity. For example, critical.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical.
PatchState: A patch state. For example, InstancesWithFailedPatches.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItemsRequest - InternalServerErrorException - An error occurred on the server side.InvalidItemContentException - One or more content items is not valid.TotalSizeLimitExceededException - The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException - The inventory item size has exceeded the size limit.ComplianceTypeCountLimitExceededException - You specified too many custom compliance types. You can specify a maximum of 10 different types.InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.PutInventoryResult putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventoryRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidTypeNameException - The parameter type name is not valid.InvalidItemContentException - One or more content items is not valid.TotalSizeLimitExceededException - The size of inventory data has exceeded the total size limit for the resource.ItemSizeLimitExceededException - The inventory item size has exceeded the size limit.ItemContentMismatchException - The inventory item has invalid content.CustomSchemaCountLimitExceededException - You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.UnsupportedInventorySchemaVersionException - Inventory item type schema version has to match supported versions in the service. Check output of
GetInventorySchema to see the available schema version for each type.UnsupportedInventoryItemContextException - The Context attribute that you specified for the InventoryItem is not allowed
for this inventory type. You can only use the Context attribute with inventory types like
AWS:ComplianceItem.InvalidInventoryItemContextException - You specified invalid keys or values in the Context attribute for InventoryItem
. Verify the keys and values, and try again.SubTypeCountLimitExceededException - The sub-type count exceeded the limit for the inventory type.PutParameterResult putParameter(PutParameterRequest putParameterRequest)
Add a parameter to the system.
putParameterRequest - InternalServerErrorException - An error occurred on the server side.InvalidKeyIdException - The query key ID is not valid.ParameterLimitExceededException - You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try
again.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.ParameterAlreadyExistsException - The parameter already exists. You can't create duplicate parameters.HierarchyLevelLimitExceededException - A hierarchy can have a maximum of 15 levels. For more information, see Requirements and constraints for parameter names in the AWS Systems Manager User Guide.HierarchyTypeMismatchException - Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change
a parameter from a String type to a SecureString type. You must create a new,
unique parameter.InvalidAllowedPatternException - The request does not meet the regular expression requirement.ParameterMaxVersionLimitExceededException - The parameter exceeded the maximum number of allowed versions.ParameterPatternMismatchException - The parameter name is not valid.UnsupportedParameterTypeException - The parameter type is not supported.PoliciesLimitExceededException - You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.InvalidPolicyTypeException - The policy type is not supported. Parameter Store supports the following policy types: Expiration,
ExpirationNotification, and NoChangeNotification.InvalidPolicyAttributeException - A policy attribute or its value is invalid.IncompatiblePolicyException - There is a conflict in the policies specified for this parameter. You can't, for example, specify two
Expiration policies for a parameter. Review your policies, and try again.RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID
value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of
pb-0574b43a65ea646ed.
registerDefaultPatchBaselineRequest - InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest registerPatchBaselineForPatchGroupRequest)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroupRequest - AlreadyExistsException - Error returned if an attempt is made to register a patch group with a patch baseline that is already
registered with a different patch baseline.DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.ResourceLimitExceededException - Error returned when the caller has exceeded the default resource quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest registerTargetWithMaintenanceWindowRequest)
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindowRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
ResourceLimitExceededException - Error returned when the caller has exceeded the default resource quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest registerTaskWithMaintenanceWindowRequest)
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindowRequest - IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
ResourceLimitExceededException - Error returned when the caller has exceeded the default resource quotas. For example, too many
maintenance windows or patch baselines have been created.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
FeatureNotAvailableException - You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service is
not available.InternalServerErrorException - An error occurred on the server side.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes tag keys from the specified resource.
removeTagsFromResourceRequest - InvalidResourceTypeException - The resource type is not valid. For example, if you are attempting to tag an instance, the instance must
be a registered, managed instance.InvalidResourceIdException - The resource ID is not valid. Verify that you entered the correct ID and try again.InternalServerErrorException - An error occurred on the server side.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.ResetServiceSettingResult resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for
a SettingId. You can't create a new SettingId, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting permission for the setting. Use the
GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to
change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
resetServiceSettingRequest - The request body of the ResetServiceSetting API action.InternalServerErrorException - An error occurred on the server side.ServiceSettingNotFoundException - The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.ResumeSessionResult resumeSession(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to an instance 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 is not intended for any other use.
resumeSessionRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.SendAutomationSignalResult sendAutomationSignal(SendAutomationSignalRequest sendAutomationSignalRequest)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignalRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.AutomationStepNotFoundException - The specified step name and execution ID don't exist. Verify the information and try again.InvalidAutomationSignalException - The signal is not valid for the current Automation execution.InternalServerErrorException - An error occurred on the server side.SendCommandResult sendCommand(SendCommandRequest sendCommandRequest)
Runs commands on one or more managed instances.
sendCommandRequest - DuplicateInstanceIdException - You cannot specify an instance ID in more than one association.InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidOutputFolderException - The S3 bucket does not exist.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.UnsupportedPlatformTypeException - The document does not support the platform type of the given instance ID(s). For example, you sent an
document for a Windows instance to a Linux instance.MaxDocumentSizeExceededException - The size limit of a document is 64 KB.InvalidRoleException - The role name can't contain invalid characters. Also verify that you specified an IAM role for
notifications that includes the required trust policy. For information about configuring the IAM role for
Run Command notifications, see Configuring
Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.InvalidNotificationConfigException - One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided
for an Amazon SNS topic.StartAssociationsOnceResult startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
startAssociationsOnceRequest - InvalidAssociationException - The association is not valid or does not exist.AssociationDoesNotExistException - The specified association does not exist.StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation document.
startAutomationExecutionRequest - AutomationDefinitionNotFoundException - An Automation document with the specified name could not be found.InvalidAutomationExecutionParametersException - The supplied parameters for invoking the specified Automation document are incorrect. For example, they
may not match the set of parameters permitted for the specified Automation document.AutomationExecutionLimitExceededException - The number of simultaneously running Automation executions exceeded the allowable limit.AutomationDefinitionVersionNotFoundException - An Automation document with the specified name and version could not be found.IdempotentParameterMismatchException - Error returned when an idempotent operation is retried and the parameters don't match the original call
to the API with the same idempotency token.InvalidTargetException - The target is not valid or does not exist. It might not be configured for Systems Manager or you might
not have permission to perform the operation.InternalServerErrorException - An error occurred on the server side.StartSessionResult startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to
be installed on the client machine making the call. For information, see Install the Session Manager plugin for the AWS CLI in the AWS Systems Manager User Guide.
AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.
startSessionRequest - InvalidDocumentException - The specified document does not exist.TargetNotConnectedException - The specified target instance for the session is not fully configured for use with Session Manager. For
more information, see Getting started with Session Manager in the AWS Systems Manager User Guide.InternalServerErrorException - An error occurred on the server side.StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest stopAutomationExecutionRequest)
Stop an Automation that is currently running.
stopAutomationExecutionRequest - AutomationExecutionNotFoundException - There is no automation execution information for the requested automation execution ID.InvalidAutomationStatusUpdateException - The specified update status operation is not valid.InternalServerErrorException - An error occurred on the server side.TerminateSessionResult terminateSession(TerminateSessionRequest terminateSessionRequest)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
terminateSessionRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.UpdateAssociationResult updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
In order to call this API action, your IAM user account, group, or role must be configured with permission to
call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then
you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets.
updateAssociationRequest - InternalServerErrorException - An error occurred on the server side.InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.InvalidParametersException - You must specify values for all required parameters in the Systems Manager document. You can only supply
values to parameters defined in the Systems Manager document.InvalidOutputLocationException - The output location is not valid or does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.AssociationDoesNotExistException - The specified association does not exist.InvalidUpdateException - The update is not valid.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.InvalidDocumentException - The specified document does not exist.InvalidTargetException - The target is not valid or does not exist. It might not be configured for Systems Manager or you might
not have permission to perform the operation.InvalidAssociationVersionException - The version you specified is not valid. Use ListAssociationVersions to view all versions of an
association according to the association ID. Or, use the $LATEST parameter to view the
latest version of the association.AssociationVersionLimitExceededException - You have reached the maximum number versions allowed for an association. Each association has a limit of
1,000 versions.UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Systems Manager document associated with the specified instance.
updateAssociationStatusRequest - InternalServerErrorException - An error occurred on the server side.InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InvalidDocumentException - The specified document does not exist.AssociationDoesNotExistException - The specified association does not exist.StatusUnchangedException - The updated status is the same as the current status.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.UpdateDocumentResult updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates one or more values for an SSM document.
updateDocumentRequest - MaxDocumentSizeExceededException - The size limit of a document is 64 KB.DocumentVersionLimitExceededException - The document has too many versions. Delete one or more document versions and try again.InternalServerErrorException - An error occurred on the server side.DuplicateDocumentContentException - The content of the association document matches another document. Change the content of the document and
try again.DuplicateDocumentVersionNameException - The version name has already been used in this document. Specify a different version name, and then try
again.InvalidDocumentContentException - The content for the document is not valid.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidDocumentSchemaVersionException - The version of the document schema is not supported.InvalidDocumentException - The specified document does not exist.InvalidDocumentOperationException - You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.UpdateDocumentDefaultVersionResult updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
updateDocumentDefaultVersionRequest - InternalServerErrorException - An error occurred on the server side.InvalidDocumentException - The specified document does not exist.InvalidDocumentVersionException - The document version is not valid or does not exist.InvalidDocumentSchemaVersionException - The version of the document schema is not supported.UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)
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.
updateMaintenanceWindowRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)
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 is not modified.
updateMaintenanceWindowTargetRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field is
not modified. If you set Replace to true, then all fields required by the
RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't
specified are set to null.
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 do not 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.
updateMaintenanceWindowTaskRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Changes the Amazon Identity and Access Management (IAM) role that is assigned to the on-premises instance or virtual machines (VM). IAM roles are first assigned to these hybrid instances during the activation process. For more information, see CreateActivation.
updateManagedInstanceRoleRequest - InvalidInstanceIdException - The following problems can cause this exception:
You do not have permission to access the instance.
SSM Agent is not running. Verify that SSM Agent is running.
SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.
The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.
InternalServerErrorException - An error occurred on the server side.UpdateOpsItemResult updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
updateOpsItemRequest - InternalServerErrorException - An error occurred on the server side.OpsItemNotFoundException - The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemAlreadyExistsException - The OpsItem already exists.OpsItemLimitExceededException - The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException - A specified parameter argument isn't valid. Verify the available arguments and try again.UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key and value pairs in PatchFilters for each supported operating system
type, see PatchFilter.
updatePatchBaselineRequest - DoesNotExistException - Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline,
doesn't exist.
For information about resource quotas in Systems Manager, see Systems Manager service quotas in the AWS General Reference.
InternalServerErrorException - An error occurred on the server side.UpdateResourceDataSyncResult updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.
This API action only supports a resource data sync that was created with a SyncFromSource SyncType.
updateResourceDataSyncRequest - ResourceDataSyncNotFoundException - The specified sync name was not found.ResourceDataSyncInvalidConfigurationException - The specified sync configuration is invalid.ResourceDataSyncConflictException - Another UpdateResourceDataSync request is being processed. Wait a few minutes and try again.InternalServerErrorException - An error occurred on the server side.UpdateServiceSettingResult updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)
ServiceSetting is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId object to a setting value. AWS services teams define the default value for
a SettingId. You can't create a new SettingId, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting permission for the setting. Use the
GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change
the value back to the original value defined by the AWS service team.
Update the service setting for the account.
updateServiceSettingRequest - The request body of the UpdateServiceSetting API action.InternalServerErrorException - An error occurred on the server side.ServiceSettingNotFoundException - The specified service setting was not found. Either the service name or the setting has not been
provisioned by the AWS service team.TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AWSSimpleSystemsManagementWaiters waiters()
Copyright © 2020. All rights reserved.