@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.
Amazon Web Services Systems Manager is the operations hub for your Amazon Web Services applications and resources and a secure end-to-end management solution for hybrid cloud environments that enables safe and secure operations at scale.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide. To get started, see Setting up Amazon Web Services Systems Manager.
Related resources
For information about each of the capabilities that comprise Systems Manager, see Systems Manager capabilities in the Amazon Web Services Systems Manager User Guide.
For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the Systems Manager Automation runbook reference .
For information about AppConfig, a capability of Systems Manager, see the AppConfig User Guide and the AppConfig API Reference .
For information about Incident Manager, a capability of Systems Manager, see the Systems Manager Incident Manager User Guide and the Systems Manager Incident Manager API Reference .
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.
|
AssociateOpsItemRelatedItemResult |
associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest)
Associates a related item to a Systems Manager OpsCenter OpsItem.
|
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 haven't
already starting running.
|
CreateActivationResult |
createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or
virtual machine (VM) with Amazon Web Services Systems Manager.
|
CreateAssociationResult |
createAssociation(CreateAssociationRequest createAssociationRequest)
A State Manager association defines the state that you want to maintain on your managed nodes.
|
CreateAssociationBatchResult |
createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed
nodes or targets.
|
CreateDocumentResult |
createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Amazon Web Services Systems Manager (SSM document).
|
CreateMaintenanceWindowResult |
createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)
Creates a new maintenance window.
|
CreateOpsItemResult |
createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem.
|
CreateOpsMetadataResult |
createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API
operation to specify information about the new application, including the application type.
|
CreatePatchBaselineResult |
createPatchBaseline(CreatePatchBaselineRequest 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 Amazon Web Services Systems Manager document (SSM document) from the specified
managed node.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest deleteDocumentRequest)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node 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.
|
DeleteOpsItemResult |
deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest)
Delete an OpsItem.
|
DeleteOpsMetadataResult |
deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
|
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.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a Systems Manager resource policy.
|
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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the
number of nodes registered by using this activation.
|
DescribeAssociationResult |
describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or managed node.
|
DescribeAssociationExecutionsResult |
describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Views all executions for a specific association ID.
|
DescribeAssociationExecutionTargetsResult |
describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Views 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 Amazon Web Services Systems Manager document (SSM document).
|
DescribeDocumentPermissionResult |
describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).
|
DescribeEffectiveInstanceAssociationsResult |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the managed nodes.
|
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 managed nodes.
|
DescribeInstanceInformationResult |
describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent
version, association status, and IP address.
|
DescribeInstancePatchesResult |
describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified managed node and their state relative to the patch
baseline being used for the node.
|
DescribeInstancePatchStatesResult |
describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more managed nodes.
|
DescribeInstancePatchStatesForPatchGroupResult |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the managed nodes in the specified patch group.
|
DescribeInstancePropertiesResult |
describeInstanceProperties(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
|
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 Amazon Web Services 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 a managed node 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)
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
|
DescribePatchBaselinesResult |
describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your Amazon Web Services 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 information 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.
|
DisassociateOpsItemRelatedItemResult |
disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest)
Deletes the association between an OpsItem and a related item.
|
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 a Amazon Web Services Systems Manager change calendar at the current time or a 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 a managed node 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 managed node uses.
|
GetDocumentResult |
getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM 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)
Retrieves the details of a maintenance window task.
|
GetOpsItemResult |
getOpsItem(GetOpsItemRequest getOpsItemRequest)
Get information about an OpsItem by using the ID.
|
GetOpsMetadataResult |
getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
|
GetOpsSummaryResult |
getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of operations metadata (OpsData) based on specified filters and aggregators.
|
GetParameterResult |
getParameter(GetParameterRequest getParameterRequest)
Get information about a single parameter by specifying the parameter name.
|
GetParameterHistoryResult |
getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
|
GetParametersResult |
getParameters(GetParametersRequest getParametersRequest)
Get information about one or more parameters by specifying multiple parameter names.
|
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.
|
GetResourcePoliciesResult |
getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Returns an array of the
Policy object. |
GetServiceSettingResult |
getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting is an account-level setting for an Amazon Web Services 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 Amazon Web Services account and Amazon Web Services 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 managed node.
|
ListCommandsResult |
listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the Amazon Web Services account.
|
ListComplianceItemsResult |
listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API operation 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.
|
ListDocumentMetadataHistoryResult |
listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of a change template in Change Manager.
|
ListDocumentsResult |
listDocuments()
Simplified method form for invoking the ListDocuments operation.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services
Region.
|
ListDocumentVersionsResult |
listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
|
ListInventoryEntriesResult |
listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)
A list of inventory items returned by the request.
|
ListOpsItemEventsResult |
listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.
|
ListOpsItemRelatedItemsResult |
listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
|
ListOpsMetadataResult |
listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata
objects or blobs.
|
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 Amazon Web Services Systems Manager document (SSM 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 or more managed nodes.
|
PutParameterResult |
putParameter(PutParameterRequest putParameterRequest)
Add a parameter to the system.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a Systems Manager resource policy.
|
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 Amazon Web Services service. |
ResumeSessionResult |
resumeSession(ResumeSessionRequest resumeSessionRequest)
Reconnects a session to a managed node 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 nodes.
|
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)
Runs an association immediately and only one time.
|
StartAutomationExecutionResult |
startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation runbook.
|
StartChangeRequestExecutionResult |
startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
Creates a change request for Change Manager.
|
StartSessionResult |
startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, a managed node) 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
managed node.
|
UnlabelParameterVersionResult |
unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
|
UpdateAssociationResult |
updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association.
|
UpdateAssociationStatusResult |
updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the
specified managed node.
|
UpdateDocumentResult |
updateDocument(UpdateDocumentRequest updateDocumentRequest)
Updates one or more values for an SSM document.
|
UpdateDocumentDefaultVersionResult |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest updateDocumentDefaultVersionRequest)
Set the default version of a document.
|
UpdateDocumentMetadataResult |
updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a change template in Change Manager.
|
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 Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or
virtual machines (VM).
|
UpdateOpsItemResult |
updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)
Edit or change an OpsItem.
|
UpdateOpsMetadataResult |
updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
|
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 Amazon Web Services 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 automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:
Key=Owner,Value=DbAdmin
Key=Owner,Value=SysAdmin
Key=Owner,Value=Dev
Key=Stack,Value=Production
Key=Stack,Value=Pre-Production
Key=Stack,Value=Test
Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResourceRequest
- InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance
must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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.AssociateOpsItemRelatedItemResult associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest associateOpsItemRelatedItemRequest)
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
associateOpsItemRelatedItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemRelatedItemAlreadyExistsException
- The Amazon Resource Name (ARN) is already associated with the OpsItem.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.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.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
DuplicateInstanceIdException
- You can't specify a managed node 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 haven't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
CreateActivationResult createActivation(CreateActivationRequest createActivationRequest)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
createActivationRequest
- InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document
(SSM document). You can only supply values to parameters defined in the SSM document.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 managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
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 SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node IDs. For example, you sent an
document for a Windows managed node to a Linux node.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document
(SSM document). You can only supply values to parameters defined in the SSM document.InvalidTargetException
- The target isn't valid or doesn't 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.InvalidTargetMapsException
- TargetMap parameter isn't valid.InvalidTagException
- The specified tag key or value isn't valid.CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.
If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatchRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document
(SSM document). You can only supply values to parameters defined in the SSM document.DuplicateInstanceIdException
- You can't specify a managed node ID in more than one association.AssociationLimitExceededException
- You can have at most 2,000 active associations.UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node IDs. For example, you sent an
document for a Windows managed node to a Linux node.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidTargetException
- The target isn't valid or doesn't 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.InvalidTargetMapsException
- TargetMap parameter isn't valid.CreateDocumentResult createDocument(CreateDocumentRequest createDocumentRequest)
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
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 isn't valid.DocumentLimitExceededException
- You can have at most 500 active SSM documents.InvalidDocumentSchemaVersionException
- The version of the document schema isn't 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 Amazon Web Services General Reference.
InternalServerErrorException
- An error occurred on the server side.CreateOpsItemResult createOpsItem(CreateOpsItemRequest createOpsItemRequest)
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
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.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is
configured either as a Systems Manager delegated administrator or that you are logged into the
Organizations management account.CreateOpsMetadataResult createOpsMetadata(CreateOpsMetadataRequest createOpsMetadataRequest)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
createOpsMetadataRequest
- OpsMetadataAlreadyExistsException
- An OpsMetadata object already exists for the selected resource.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments and try again.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataLimitExceededException
- Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The
maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.InternalServerErrorException
- An error occurred on the server side.CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest createPatchBaselineRequest)
Creates a patch baseline.
For information about valid key-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 Amazon Web Services 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. Amazon Web Services Systems
Manager offers two types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3)
bucket. For more information, see Configuring
resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon
S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon
Web Services Regions or EntireOrganization
by using Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services
Systems Manager User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
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 aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
deleteActivationRequest
- InvalidActivationIdException
- The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try
again.InvalidActivationException
- The activation isn't valid. The activation might have been deleted, or the ActivationId and the
ActivationCode don't 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 Amazon Web Services Systems Manager document (SSM document) from the specified
managed node. If you created the association by using the Targets
parameter, then you must delete
the association by using the association ID.
When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
deleteAssociationRequest
- AssociationDoesNotExistException
- The specified association doesn't exist.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and 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 Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
deleteDocumentRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't 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 managed nodes 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 isn't valid.InvalidOptionException
- The delete inventory option specified isn't valid. Verify the option and try again.InvalidDeleteInventoryParametersException
- One or more of the parameters specified for the delete operation isn't valid. Verify all parameters and
try again.InvalidInventoryRequestException
- The request isn't valid.DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest deleteMaintenanceWindowRequest)
Deletes a maintenance window.
deleteMaintenanceWindowRequest
- InternalServerErrorException
- An error occurred on the server side.DeleteOpsItemResult deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest)
Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.
Note the following important information about this operation.
Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.
This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.
This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.
This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.
deleteOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.DeleteOpsMetadataResult deleteOpsMetadata(DeleteOpsMetadataRequest deleteOpsMetadataRequest)
Delete OpsMetadata related to an application.
deleteOpsMetadataRequest
- OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.DeleteParameterResult deleteParameter(DeleteParameterRequest deleteParameterRequest)
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParameterRequest
- InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.DeleteParametersResult deleteParameters(DeleteParametersRequest deleteParametersRequest)
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
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 nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
deleteResourceDataSyncRequest
- InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
OpsItemGroup
- The resource policy for OpsItemGroup
enables Amazon Web Services
accounts to view and interact with OpsCenter operational work items (OpsItems).
Parameter
- The resource policy is used to share a parameter with other accounts using Resource
Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
deleteResourcePolicyRequest
- InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values and
try again.ResourcePolicyConflictException
- The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to
update an obsolete policy version or when multiple requests to update a policy are sent.ResourceNotFoundException
- The specified parameter to be shared could not be found.MalformedResourcePolicyDocumentException
- The specified policy document is malformed or invalid, or excessive PutResourcePolicy
or
DeleteResourcePolicy
calls have been made.ResourcePolicyNotFoundException
- No policies with the specified policy ID and hash could be found.DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstanceRequest
- InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and 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 isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
describeActivationsRequest
- InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.InternalServerErrorException
- An error occurred on the server side.DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)
Describes the association for the specified target or managed node. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID.
describeAssociationRequest
- AssociationDoesNotExistException
- The specified association doesn't exist.InvalidAssociationVersionException
- The version you specified isn't 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 SSM document doesn't exist.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
DescribeAssociationExecutionTargetsResult describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest describeAssociationExecutionTargetsRequest)
Views information about a specific execution of a specific association.
describeAssociationExecutionTargetsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't valid.AssociationExecutionDoesNotExistException
- The specified execution ID doesn't exist. Verify the ID number and try again.DescribeAssociationExecutionsResult describeAssociationExecutions(DescribeAssociationExecutionsRequest describeAssociationExecutionsRequest)
Views all executions for a specific association ID.
describeAssociationExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't valid.DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest describeAutomationExecutionsRequest)
Provides details about all active and terminated Automation executions.
describeAutomationExecutionsRequest
- InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't 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 isn't valid.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterValueException
- The filter value isn't 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.
Currently, DescribeAvailablePatches
supports only the Amazon Linux 1, Amazon Linux 2, and Windows
Server operating systems.
describeAvailablePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest)
Describes the specified Amazon Web Services Systems Manager document (SSM document).
describeDocumentRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest describeDocumentPermissionRequest)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
describeDocumentPermissionRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidNextTokenException
- The specified token isn't valid.InvalidPermissionTypeException
- The permission type isn't supported. Share is the only supported permission type.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)
All associations for the managed nodes.
describeEffectiveInstanceAssociationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidNextTokenException
- The specified token isn't valid.DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest describeEffectivePatchesForPatchBaselineRequest)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
describeEffectivePatchesForPatchBaselineRequest
- InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating
system.InternalServerErrorException
- An error occurred on the server side.DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)
The status of the associations for the managed nodes.
describeInstanceAssociationsStatusRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidNextTokenException
- The specified token isn't valid.DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)
Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.
If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.
The IamRole
field returned for this API operation is the Identity and Access Management (IAM) role
assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.
describeInstanceInformationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidNextTokenException
- The specified token isn't valid.InvalidInstanceInformationFilterValueException
- The specified filter value isn't valid.InvalidFilterKeyException
- The specified key isn't valid.DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest describeInstancePatchStatesRequest)
Retrieves the high-level patch state of one or more managed nodes.
describeInstancePatchStatesRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest describeInstancePatchStatesForPatchGroupRequest)
Retrieves the high-level patch state for the managed nodes in the specified patch group.
describeInstancePatchStatesForPatchGroupRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
describeInstancePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.DescribeInstancePropertiesResult describeInstanceProperties(DescribeInstancePropertiesRequest describeInstancePropertiesRequest)
An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.
describeInstancePropertiesRequest
- InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't valid.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidActivationIdException
- The activation ID isn't valid. Verify the you entered the correct ActivationId or ActivationCode and try
again.InvalidInstancePropertyFilterValueException
- The specified filter value isn't valid.InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.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 doesn't exist or isn't valid. Verify the ID and try again.InvalidNextTokenException
- The specified token isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InternalServerErrorException
- An error occurred on the server side.DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values don't affect the running of your task and can be
ignored.
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InternalServerErrorException
- An error occurred on the server side.DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest describeMaintenanceWindowsRequest)
Retrieves the maintenance windows in an Amazon Web Services account.
describeMaintenanceWindowsRequest
- InternalServerErrorException
- An error occurred on the server side.DescribeMaintenanceWindowsForTargetResult describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest describeMaintenanceWindowsForTargetRequest)
Retrieves information about the maintenance window targets or tasks that a managed node 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 Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
describeOpsItemsRequest
- InternalServerErrorException
- An error occurred on the server side.DescribeParametersResult describeParameters(DescribeParametersRequest describeParametersRequest)
Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, DescribeParameters
retrieves whatever the
original key alias was referencing.
describeParametersRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidNextTokenException
- The specified token isn't valid.DescribePatchBaselinesResult describePatchBaselines(DescribePatchBaselinesRequest describePatchBaselinesRequest)
Lists the patch baselines in your Amazon Web Services account.
describePatchBaselinesRequest
- InternalServerErrorException
- An error occurred on the server side.DescribePatchGroupStateResult describePatchGroupState(DescribePatchGroupStateRequest describePatchGroupStateRequest)
Returns high-level aggregated patch compliance state information for a patch group.
describePatchGroupStateRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't 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 operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| PRIORITY
Valid properties: PRODUCT
| CLASSIFICATION
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| PRIORITY
Valid properties: PRODUCT
| PRODUCT_FAMILY
| CLASSIFICATION
|
MSRC_SEVERITY
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 isn't valid.InvalidNextTokenException
- The specified token isn't valid.DisassociateOpsItemRelatedItemResult disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest disassociateOpsItemRelatedItemRequest)
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
disassociateOpsItemRelatedItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemRelatedItemAssociationNotFoundException
- The association wasn't found using the parameters you specified in the call. Verify the information and
try again.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.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 a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
If you specify a time, GetCalendarState
returns the state of the calendar at that specific time, and
returns the next time that the change calendar state will transition. If you don't specify a time,
GetCalendarState
uses the current time. Change Calendar entries have two possible states:
OPEN
or CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
getCalendarStateRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentTypeException
- The SSM document type isn't valid. Valid document types are described in the DocumentType
property.UnsupportedCalendarException
- The calendar entry contained in the specified SSM document isn't supported.GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command
execution status on a specific managed node, use ListCommandInvocations. To get the command execution
status across managed nodes, use ListCommands.
getCommandInvocationRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidPluginNameException
- The plugin name isn't valid.InvocationDoesNotExistException
- The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and
the managed node ID and try again.GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)
Retrieves the Session Manager connection status for a managed node 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. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaselineRequest
- InternalServerErrorException
- An error occurred on the server side.GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the
AWS-RunPatchBaseline
Systems Manager document (SSM document).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your
local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the
Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems
Manager, with an SSM document that enables you to target a managed node with a script or command. For example,
run the command using the AWS-RunShellScript
document or the AWS-RunPowerShellScript
document.
getDeployablePatchSnapshotForInstanceRequest
- InternalServerErrorException
- An error occurred on the server side.UnsupportedOperatingSystemException
- The operating systems you specified isn't supported, or the operation isn't supported for the operating
system.UnsupportedFeatureRequiredException
- Patching for applications released by Microsoft is only available on EC2 instances and advanced
instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable
advanced instances. For more information, see Turning on the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
getDocumentRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.GetInventoryResult getInventory(GetInventoryRequest getInventoryRequest)
Query inventory information. This includes managed node status, such as Stopped
or
Terminated
.
getInventoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidInventoryGroupException
- The specified inventory group isn't valid.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't 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 isn't 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 isn't valid.InvalidNextTokenException
- The specified token isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InternalServerErrorException
- An error occurred on the server side.GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)
Retrieves the details of a maintenance window task.
For maintenance window tasks without a specified target, you can't supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values don't affect the running of your task and can be
ignored.
To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
getOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is
configured either as a Systems Manager delegated administrator or that you are logged into the
Organizations management account.GetOpsMetadataResult getOpsMetadata(GetOpsMetadataRequest getOpsMetadataRequest)
View operational metadata related to an application in Application Manager.
getOpsMetadataRequest
- OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.GetOpsSummaryResult getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
getOpsSummaryRequest
- InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't found.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidTypeNameException
- The parameter type name isn't valid.InvalidAggregatorException
- The specified aggregator isn't 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 single parameter by specifying the parameter name.
To get information about more than one parameter at a time, use the GetParameters operation.
getParameterRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidKeyIdException
- The query key ID isn't valid.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't found. Verify the parameter name and version, and try again.GetParameterHistoryResult getParameterHistory(GetParameterHistoryRequest getParameterHistoryRequest)
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, GetParameterHistory
retrieves whatever the
original key alias was referencing.
getParameterHistoryRequest
- InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.InvalidNextTokenException
- The specified token isn't valid.InvalidKeyIdException
- The query key ID isn't valid.GetParametersResult getParameters(GetParametersRequest getParametersRequest)
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
getParametersRequest
- InvalidKeyIdException
- The query key ID isn't 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 isn't valid.InvalidFilterOptionException
- The specified filter option isn't valid. Valid options are Equals and BeginsWith. For Path filter, valid
options are Recursive and OneLevel.InvalidFilterValueException
- The filter value isn't valid. Verify the value and try again.InvalidKeyIdException
- The query key ID isn't valid.InvalidNextTokenException
- The specified token isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InvalidResourceIdException
- The resource ID isn't 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.GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Returns an array of the Policy
object.
getResourcePoliciesRequest
- InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values and
try again.ResourceNotFoundException
- The specified parameter to be shared could not be found.GetServiceSettingResult getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services service team
might create a default setting of false
. This means the user can't use this feature unless they
change the setting to true
and intentionally opt in for a paid feature.
Services map a SettingId
object to a setting value. Amazon Web Services services teams define the
default value for a SettingId
. You can't create a new SettingId
, but you can overwrite
the default value if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the Amazon Web Services service team.
Query the current service setting for the Amazon Web Services account.
getServiceSettingRequest
- The request body of the GetServiceSetting API operation.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been
provisioned by the Amazon Web Services 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, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws
" or "ssm
" (not case sensitive). If a label fails
to meet these requirements, then the label isn't associated with a parameter and the system displays it in the
list of InvalidLabels.
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 couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't 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 isn't valid.AssociationDoesNotExistException
- The specified association doesn't exist.ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
listAssociationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed
nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand
against three managed nodes, then a command invocation is created for each requested managed node ID.
ListCommandInvocations
provide status about command execution.
listCommandInvocationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't valid.ListCommandsResult listCommands(ListCommandsRequest listCommandsRequest)
Lists the commands requested by users of the Amazon Web Services account.
listCommandsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidCommandIdException
- The specified command ID isn't valid. Verify the ID and try again.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't valid.ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItemsRequest
- InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance
must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.InternalServerErrorException
- An error occurred on the server side.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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 isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.InternalServerErrorException
- An error occurred on the server side.ListDocumentMetadataHistoryResult listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest listDocumentMetadataHistoryRequest)
Information about approval reviews for a version of a change template in Change Manager.
listDocumentMetadataHistoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidNextTokenException
- The specified token isn't valid.ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest listDocumentVersionsRequest)
List all versions for a document.
listDocumentVersionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidDocumentException
- The specified SSM document doesn't exist.ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
listDocumentsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't 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 don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidTypeNameException
- The parameter type name isn't valid.InvalidFilterException
- The filter name isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't valid.ListOpsItemEventsResult listOpsItemEvents(ListOpsItemEventsRequest listOpsItemEventsRequest)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsItemEventsRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.ListOpsItemRelatedItemsResult listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest listOpsItemRelatedItemsRequest)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
listOpsItemRelatedItemsRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.ListOpsMetadataResult listOpsMetadata(ListOpsMetadataRequest listOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadataRequest
- OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.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 isn't valid. Verify the you entered the correct name and try again.InvalidNextTokenException
- The specified token isn't 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 isn't valid.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
listTagsForResourceRequest
- InvalidResourceTypeException
- The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance
must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermissionRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidPermissionTypeException
- The permission type isn't supported. Share is the only supported permission type.DocumentPermissionLimitException
- The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20
accounts per API operation to share a private document.
By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.
If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.
DocumentLimitExceededException
- You can have at most 500 active SSM documents.PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, Critical
.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline
.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify
the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItemsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidItemContentException
- One or more content items isn't 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 isn't valid. For example, if you are attempting to tag an EC2 instance, the instance
must be a registered managed node.InvalidResourceIdException
- The resource ID isn't valid. Verify that you entered the correct ID and try again.PutInventoryResult putInventory(PutInventoryRequest putInventoryRequest)
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventoryRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidTypeNameException
- The parameter type name isn't valid.InvalidItemContentException
- One or more content items isn't 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
isn't 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 isn't valid.ParameterLimitExceededException
- You have exceeded the number of parameters for this Amazon Web Services 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 Amazon Web Services Systems Manager User
Guide.HierarchyTypeMismatchException
- Parameter Store doesn't 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 doesn't meet the regular expression requirement.ParameterMaxVersionLimitExceededException
- Parameter Store retains the 100 most recently created versions of a parameter. After this number of
versions has been created, Parameter Store deletes the oldest version when a new one is created. However,
if the oldest version has a label attached to it, Parameter Store won't delete the version and
instead presents this error message:
An error occurred (ParameterMaxVersionLimitExceeded) when calling the PutParameter operation: You attempted to create a new version of parameter-name by calling the PutParameter API with the overwrite flag. Version version-number, the oldest version, can't be deleted because it has a label associated with it. Move the label to another version of the parameter, and try again.
This safeguard is to prevent parameter versions with mission critical labels assigned to them from being deleted. To continue creating new parameters, first move the label from the oldest version of the parameter to a newer one for use in your operations. For information about moving parameter labels, see Move a parameter label (console) or Move a parameter label (CLI) in the Amazon Web Services Systems Manager User Guide.
ParameterPatternMismatchException
- The parameter name isn't valid.UnsupportedParameterTypeException
- The parameter type isn't supported.PoliciesLimitExceededException
- You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.InvalidPolicyTypeException
- The policy type isn't 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.PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.
OpsItemGroup
- The resource policy for OpsItemGroup
enables Amazon Web Services
accounts to view and interact with OpsCenter operational work items (OpsItems).
Parameter
- The resource policy is used to share a parameter with other accounts using Resource
Access Manager (RAM).
To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.
To share a SecureString
parameter, it must be encrypted with a customer managed key, and you must
share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared.
Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed
key instead. For KMS key definitions, see KMS concepts in the Key
Management Service Developer Guide.
While you can share a parameter using the Systems Manager PutResourcePolicy
operation, we recommend
using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy
requires the
extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the
Systems Manager DescribeParameters API operation using the --shared
option.
For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide
putResourcePolicyRequest
- InternalServerErrorException
- An error occurred on the server side.ResourcePolicyInvalidParameterException
- One or more parameters specified for the call aren't valid. Verify the parameters and their values and
try again.ResourcePolicyLimitExceededException
- The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in
size. And only one policy can be attached to OpsItemGroup
. Verify these limits and try
again.ResourcePolicyConflictException
- The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to
update an obsolete policy version or when multiple requests to update a policy are sent.ResourceNotFoundException
- The specified parameter to be shared could not be found.MalformedResourcePolicyDocumentException
- The specified policy document is malformed or invalid, or excessive PutResourcePolicy
or
DeleteResourcePolicy
calls have been made.ResourcePolicyNotFoundException
- No policies with the specified policy ID and hash could be found.RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)
Defines the default patch baseline for the relevant operating system.
To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon
Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
registerDefaultPatchBaselineRequest
- InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Amazon Web Services General Reference.
FeatureNotAvailableException
- You attempted to register a LAMBDA
or STEP_FUNCTIONS
task in a region where the
corresponding service isn't 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 isn't valid. For example, if you are attempting to tag an EC2 instance, the instance
must be a registered managed node.InvalidResourceIdException
- The resource ID isn't 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 Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services service team
might create a default setting of "false". This means the user can't use this feature unless they change the
setting to "true" and intentionally opt in for a paid feature.
Services map a SettingId
object to a setting value. Amazon Web Services services teams define the
default value for a SettingId
. You can't create a new SettingId
, but you can overwrite
the default value if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API
operation to change the default setting.
Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
resetServiceSettingRequest
- The request body of the ResetServiceSetting API operation.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been
provisioned by the Amazon Web Services 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 a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 isn't 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 nodes.
sendCommandRequest
- DuplicateInstanceIdException
- You can't specify a managed node ID in more than one association.InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidOutputFolderException
- The S3 bucket doesn't exist.InvalidParametersException
- You must specify values for all required parameters in the Amazon Web Services Systems Manager document
(SSM document). You can only supply values to parameters defined in the SSM document.UnsupportedPlatformTypeException
- The document doesn't support the platform type of the given managed node IDs. For example, you sent an
document for a Windows managed node to a Linux node.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 Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web
Services Systems Manager User Guide.InvalidNotificationConfigException
- One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN) was provided
for an Amazon Simple Notification Service topic.StartAssociationsOnceResult startAssociationsOnce(StartAssociationsOnceRequest startAssociationsOnceRequest)
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
startAssociationsOnceRequest
- InvalidAssociationException
- The association isn't valid or doesn't exist.AssociationDoesNotExistException
- The specified association doesn't exist.StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest startAutomationExecutionRequest)
Initiates execution of an Automation runbook.
startAutomationExecutionRequest
- AutomationDefinitionNotFoundException
- An Automation runbook with the specified name couldn't be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation runbook 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 runbook with the specified name and version couldn't 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 isn't valid or doesn't 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.StartChangeRequestExecutionResult startChangeRequestExecution(StartChangeRequestExecutionRequest startChangeRequestExecutionRequest)
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
startChangeRequestExecutionRequest
- AutomationDefinitionNotFoundException
- An Automation runbook with the specified name couldn't be found.InvalidAutomationExecutionParametersException
- The supplied parameters for invoking the specified Automation runbook 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 runbook with the specified name and version couldn't 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.InternalServerErrorException
- An error occurred on the server side.AutomationDefinitionNotApprovedException
- Indicates that the Change Manager change template used in the change request was rejected or is still in
a pending state.StartSessionResult startSession(StartSessionRequest startSessionRequest)
Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Amazon Web Services CLI usage: start-session
is an interactive command that requires the Session
Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems
Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
startSessionRequest
- InvalidDocumentException
- The specified SSM document doesn't exist.TargetNotConnectedException
- The specified target managed node for the session isn't fully configured for use with Session Manager.
For more information, see Getting started with Session Manager in the Amazon Web Services Systems Manager User Guide.
This error is also returned if you attempt to start a session on a managed node that is located in a
different account or RegionInternalServerErrorException
- 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 isn't 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 managed node. A terminated session can't be resumed.
terminateSessionRequest
- InternalServerErrorException
- An error occurred on the server side.UnlabelParameterVersionResult unlabelParameterVersion(UnlabelParameterVersionRequest unlabelParameterVersionRequest)
Remove a label or labels from a parameter.
unlabelParameterVersionRequest
- 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 couldn't be found. Verify the name and try again.ParameterVersionNotFoundException
- The specified parameter version wasn't found. Verify the parameter name and version, and try again.UpdateAssociationResult updateAssociation(UpdateAssociationRequest updateAssociationRequest)
Updates an association. You can update the association name and version, the document version, schedule,
parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation
,
the system removes all optional parameters from the request and overwrites the association with null values for
those parameters. This is by design. You must specify all optional parameters in the call, even if you are not
changing the parameters. This includes the Name
parameter. Before calling this API action, we
recommend that you call the DescribeAssociation API operation and make a note of all optional parameters
required for your UpdateAssociation
call.
In order to call this API operation, a user, group, or role must be granted permission to call the
DescribeAssociation API operation. If you don't have permission to call DescribeAssociation
,
then you receive the following error:
An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>
When you update an association, the association immediately runs against the specified targets. You can add the
ApplyOnlyAtCronInterval
parameter to run the association during the next schedule run.
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 Amazon Web Services Systems Manager document
(SSM document). You can only supply values to parameters defined in the SSM document.InvalidOutputLocationException
- The output location isn't valid or doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidUpdateException
- The update isn't valid.TooManyUpdatesException
- There are concurrent updates for a resource that supports one update at a time.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidTargetException
- The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not
have permission to perform the operation.InvalidAssociationVersionException
- The version you specified isn't 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.InvalidTargetMapsException
- TargetMap parameter isn't valid.UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus
is primarily used by the Amazon Web Services Systems Manager Agent (SSM
Agent) to report status updates about your associations and is only used for associations created with the
InstanceId
legacy parameter.
updateAssociationStatusRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidDocumentException
- The specified SSM document doesn't exist.AssociationDoesNotExistException
- The specified association doesn't 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 isn't valid.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidDocumentSchemaVersionException
- The version of the document schema isn't supported.InvalidDocumentException
- The specified SSM document doesn't 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.
If you change a document version for a State Manager association, Systems Manager immediately runs the
association unless you previously specifed the apply-only-at-cron-interval
parameter.
updateDocumentDefaultVersionRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.InvalidDocumentSchemaVersionException
- The version of the document schema isn't supported.UpdateDocumentMetadataResult updateDocumentMetadata(UpdateDocumentMetadataRequest updateDocumentMetadataRequest)
Updates information related to approval reviews for a specific version of a change template in Change Manager.
updateDocumentMetadataRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidDocumentException
- The specified SSM document doesn't exist.InvalidDocumentOperationException
- You attempted to delete a document while it is still shared. You must stop sharing the document before
you can delete it.InvalidDocumentVersionException
- The document version isn't valid or doesn't exist.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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 isn't 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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
If the value for a parameter in UpdateMaintenanceWindowTask
is null, then the corresponding field
isn't modified. If you set Replace
to true, then all fields required by the
RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't
specified are set to null.
When you update a maintenance window task that has options specified in TaskInvocationParameters
,
you must provide again all the TaskInvocationParameters
values that you want to retain. The values
you don't specify again are removed. For example, suppose that when you registered a Run Command task, you
specified TaskInvocationParameters
values for Comment
, NotificationConfig
,
and OutputS3BucketName
. If you update the maintenance window task and specify only a different
OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services General Reference.
InternalServerErrorException
- An error occurred on the server side.UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.
updateManagedInstanceRoleRequest
- InvalidInstanceIdException
- The following problems can cause this exception:
You don't have permission to access the managed node.
Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.
SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.
The managed node isn't in a valid state. Valid states are: Running
, Pending
,
Stopped
, and 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 Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
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.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemAccessDeniedException
- You don't have permission to view OpsItems in the specified account. Verify that your account is
configured either as a Systems Manager delegated administrator or that you are logged into the
Organizations management account.OpsItemConflictException
- The specified OpsItem is in the process of being deleted.UpdateOpsMetadataResult updateOpsMetadata(UpdateOpsMetadataRequest updateOpsMetadataRequest)
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
updateOpsMetadataRequest
- OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.OpsMetadataKeyLimitExceededException
- The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an
application in Application Manager.OpsMetadataTooManyUpdatesException
- The system is processing too many concurrent updates. Wait a few moments and try again.InternalServerErrorException
- An error occurred on the server side.UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key-value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
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 Amazon Web Services Systems Manager, see Systems Manager service quotas in the Amazon Web Services 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 Organizations configuration
option. Instead, you must delete the first
resource data sync, and create a new one.
This API operation only supports a resource data sync that was created with a SyncFromSource
SyncType
.
updateResourceDataSyncRequest
- ResourceDataSyncNotFoundException
- The specified sync name wasn't 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 Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services service team
might create a default setting of "false". This means the user can't use this feature unless they change the
setting to "true" and intentionally opt in for a paid feature.
Services map a SettingId
object to a setting value. Amazon Web Services services teams define the
default value for a SettingId
. You can't create a new SettingId
, but you can overwrite
the default value if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to
change the value back to the original value defined by the Amazon Web Services service team.
Update the service setting for the account.
updateServiceSettingRequest
- The request body of the UpdateServiceSetting API operation.InternalServerErrorException
- An error occurred on the server side.ServiceSettingNotFoundException
- The specified service setting wasn't found. Either the service name or the setting hasn't been
provisioned by the Amazon Web Services 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()