@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSSimpleSystemsManagementClient extends AmazonWebServiceClient implements AWSSimpleSystemsManagement
Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A managed node is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or virtual machine (VM) that has been configured for Systems Manager.
With support for IoT Greengrass Version 2 devices, the phrase managed instance has been changed to managed node in most of the Systems Manager documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the term instance.
This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.
To get started, verify prerequisites and configure managed nodes. For more information, see Setting up Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.
Related resources
For information about how to use a Query API, see Making API requests.
For information about other API operations you can perform on EC2 instances, see the Amazon EC2 API 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 Incident Manager User Guide and the Incident Manager API Reference.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSSimpleSystemsManagementClient()
Deprecated.
|
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for
example:
AWSSimpleSystemsManagementClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSSimpleSystemsManagementClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds or overwrites one or more tags for the specified resource.
|
AssociateOpsItemRelatedItemResult |
associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest request)
Associates a related item to a Systems Manager OpsCenter OpsItem.
|
static AWSSimpleSystemsManagementClientBuilder |
builder() |
CancelCommandResult |
cancelCommand(CancelCommandRequest request)
Attempts to cancel the command specified by the Command ID.
|
CancelMaintenanceWindowExecutionResult |
cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest request)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't
already starting running.
|
CreateActivationResult |
createActivation(CreateActivationRequest request)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or
virtual machine (VM) with Amazon Web Services Systems Manager.
|
CreateAssociationResult |
createAssociation(CreateAssociationRequest request)
A State Manager association defines the state that you want to maintain on your managed nodes.
|
CreateAssociationBatchResult |
createAssociationBatch(CreateAssociationBatchRequest request)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed
nodes or targets.
|
CreateDocumentResult |
createDocument(CreateDocumentRequest request)
Creates a Amazon Web Services Systems Manager (SSM document).
|
CreateMaintenanceWindowResult |
createMaintenanceWindow(CreateMaintenanceWindowRequest request)
Creates a new maintenance window.
|
CreateOpsItemResult |
createOpsItem(CreateOpsItemRequest request)
Creates a new OpsItem.
|
CreateOpsMetadataResult |
createOpsMetadata(CreateOpsMetadataRequest request)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API
operation to specify information about the new application, including the application type.
|
CreatePatchBaselineResult |
createPatchBaseline(CreatePatchBaselineRequest request)
Creates a patch baseline.
|
CreateResourceDataSyncResult |
createResourceDataSync(CreateResourceDataSyncRequest request)
A resource data sync helps you view data from multiple sources in a single location.
|
DeleteActivationResult |
deleteActivation(DeleteActivationRequest request)
Deletes an activation.
|
DeleteAssociationResult |
deleteAssociation(DeleteAssociationRequest request)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified
managed node.
|
DeleteDocumentResult |
deleteDocument(DeleteDocumentRequest request)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the
document.
|
DeleteInventoryResult |
deleteInventory(DeleteInventoryRequest request)
Delete a custom inventory type or the data associated with a custom Inventory type.
|
DeleteMaintenanceWindowResult |
deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
Deletes a maintenance window.
|
DeleteOpsMetadataResult |
deleteOpsMetadata(DeleteOpsMetadataRequest request)
Delete OpsMetadata related to an application.
|
DeleteParameterResult |
deleteParameter(DeleteParameterRequest request)
Delete a parameter from the system.
|
DeleteParametersResult |
deleteParameters(DeleteParametersRequest request)
Delete a list of parameters.
|
DeletePatchBaselineResult |
deletePatchBaseline(DeletePatchBaselineRequest request)
Deletes a patch baseline.
|
DeleteResourceDataSyncResult |
deleteResourceDataSync(DeleteResourceDataSyncRequest request)
Deletes a resource data sync configuration.
|
DeregisterManagedInstanceResult |
deregisterManagedInstance(DeregisterManagedInstanceRequest request)
Removes the server or virtual machine from the list of registered servers.
|
DeregisterPatchBaselineForPatchGroupResult |
deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest request)
Removes a patch group from a patch baseline.
|
DeregisterTargetFromMaintenanceWindowResult |
deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest request)
Removes a target from a maintenance window.
|
DeregisterTaskFromMaintenanceWindowResult |
deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest request)
Removes a task from a maintenance window.
|
DescribeActivationsResult |
describeActivations(DescribeActivationsRequest request)
Describes details about the activation, such as the date and time the activation was created, its expiration
date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the
number of nodes registered by using this activation.
|
DescribeAssociationResult |
describeAssociation(DescribeAssociationRequest request)
Describes the association for the specified target or managed node.
|
DescribeAssociationExecutionsResult |
describeAssociationExecutions(DescribeAssociationExecutionsRequest request)
Views all executions for a specific association ID.
|
DescribeAssociationExecutionTargetsResult |
describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest request)
Views information about a specific execution of a specific association.
|
DescribeAutomationExecutionsResult |
describeAutomationExecutions(DescribeAutomationExecutionsRequest request)
Provides details about all active and terminated Automation executions.
|
DescribeAutomationStepExecutionsResult |
describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest request)
Information about all active and terminated step executions in an Automation workflow.
|
DescribeAvailablePatchesResult |
describeAvailablePatches(DescribeAvailablePatchesRequest request)
Lists all patches eligible to be included in a patch baseline.
|
DescribeDocumentResult |
describeDocument(DescribeDocumentRequest request)
Describes the specified Amazon Web Services Systems Manager document (SSM document).
|
DescribeDocumentPermissionResult |
describeDocumentPermission(DescribeDocumentPermissionRequest request)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document).
|
DescribeEffectiveInstanceAssociationsResult |
describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest request)
All associations for the managed node(s).
|
DescribeEffectivePatchesForPatchBaselineResult |
describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest request)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.
|
DescribeInstanceAssociationsStatusResult |
describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest request)
The status of the associations for the managed node(s).
|
DescribeInstanceInformationResult |
describeInstanceInformation(DescribeInstanceInformationRequest request)
Describes one or more of your managed nodes, including information about the operating system platform, the
version of SSM Agent installed on the managed node, node status, and so on.
|
DescribeInstancePatchesResult |
describeInstancePatches(DescribeInstancePatchesRequest request)
Retrieves information about the patches on the specified managed node and their state relative to the patch
baseline being used for the node.
|
DescribeInstancePatchStatesResult |
describeInstancePatchStates(DescribeInstancePatchStatesRequest request)
Retrieves the high-level patch state of one or more managed nodes.
|
DescribeInstancePatchStatesForPatchGroupResult |
describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest request)
Retrieves the high-level patch state for the managed nodes in the specified patch group.
|
DescribeInventoryDeletionsResult |
describeInventoryDeletions(DescribeInventoryDeletionsRequest request)
Describes a specific delete inventory operation.
|
DescribeMaintenanceWindowExecutionsResult |
describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest request)
Lists the executions of a maintenance window.
|
DescribeMaintenanceWindowExecutionTaskInvocationsResult |
describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance
window execution.
|
DescribeMaintenanceWindowExecutionTasksResult |
describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request)
For a given maintenance window execution, lists the tasks that were run.
|
DescribeMaintenanceWindowsResult |
describeMaintenanceWindows(DescribeMaintenanceWindowsRequest request)
Retrieves the maintenance windows in an Amazon Web Services account.
|
DescribeMaintenanceWindowScheduleResult |
describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest request)
Retrieves information about upcoming executions of a maintenance window.
|
DescribeMaintenanceWindowsForTargetResult |
describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest request)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
|
DescribeMaintenanceWindowTargetsResult |
describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request)
Lists the targets registered with the maintenance window.
|
DescribeMaintenanceWindowTasksResult |
describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request)
Lists the tasks in a maintenance window.
|
DescribeOpsItemsResult |
describeOpsItems(DescribeOpsItemsRequest request)
Query a set of OpsItems.
|
DescribeParametersResult |
describeParameters(DescribeParametersRequest request)
Get information about a parameter.
|
DescribePatchBaselinesResult |
describePatchBaselines(DescribePatchBaselinesRequest request)
Lists the patch baselines in your Amazon Web Services account.
|
DescribePatchGroupsResult |
describePatchGroups(DescribePatchGroupsRequest request)
Lists all patch groups that have been registered with patch baselines.
|
DescribePatchGroupStateResult |
describePatchGroupState(DescribePatchGroupStateRequest request)
Returns high-level aggregated patch compliance state information for a patch group.
|
DescribePatchPropertiesResult |
describePatchProperties(DescribePatchPropertiesRequest request)
Lists the properties of available patches organized by product, product family, classification, severity, and
other properties of available patches.
|
DescribeSessionsResult |
describeSessions(DescribeSessionsRequest request)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30
days.
|
DisassociateOpsItemRelatedItemResult |
disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest request)
Deletes the association between an OpsItem and a related item.
|
GetAutomationExecutionResult |
getAutomationExecution(GetAutomationExecutionRequest request)
Get detailed information about a particular Automation execution.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCalendarStateResult |
getCalendarState(GetCalendarStateRequest request)
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
|
GetCommandInvocationResult |
getCommandInvocation(GetCommandInvocationRequest request)
Returns detailed information about command execution for an invocation or plugin.
|
GetConnectionStatusResult |
getConnectionStatus(GetConnectionStatusRequest request)
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready
to receive Session Manager connections.
|
GetDefaultPatchBaselineResult |
getDefaultPatchBaseline(GetDefaultPatchBaselineRequest request)
Retrieves the default patch baseline.
|
GetDeployablePatchSnapshotForInstanceResult |
getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest request)
Retrieves the current snapshot for the patch baseline the managed node uses.
|
GetDocumentResult |
getDocument(GetDocumentRequest request)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
|
GetInventoryResult |
getInventory(GetInventoryRequest request)
Query inventory information.
|
GetInventorySchemaResult |
getInventorySchema(GetInventorySchemaRequest request)
Return a list of inventory type names for the account, or return a list of attribute names for a specific
Inventory item type.
|
GetMaintenanceWindowResult |
getMaintenanceWindow(GetMaintenanceWindowRequest request)
Retrieves a maintenance window.
|
GetMaintenanceWindowExecutionResult |
getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request)
Retrieves details about a specific a maintenance window execution.
|
GetMaintenanceWindowExecutionTaskResult |
getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request)
Retrieves the details about a specific task run as part of a maintenance window execution.
|
GetMaintenanceWindowExecutionTaskInvocationResult |
getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest request)
Retrieves information about a specific task running on a specific target.
|
GetMaintenanceWindowTaskResult |
getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request)
Lists the tasks in a maintenance window.
|
GetOpsItemResult |
getOpsItem(GetOpsItemRequest request)
Get information about an OpsItem by using the ID.
|
GetOpsMetadataResult |
getOpsMetadata(GetOpsMetadataRequest request)
View operational metadata related to an application in Application Manager.
|
GetOpsSummaryResult |
getOpsSummary(GetOpsSummaryRequest request)
View a summary of operations metadata (OpsData) based on specified filters and aggregators.
|
GetParameterResult |
getParameter(GetParameterRequest request)
Get information about a single parameter by specifying the parameter name.
|
GetParameterHistoryResult |
getParameterHistory(GetParameterHistoryRequest request)
Retrieves the history of all changes to a parameter.
|
GetParametersResult |
getParameters(GetParametersRequest request)
Get information about one or more parameters by specifying multiple parameter names.
|
GetParametersByPathResult |
getParametersByPath(GetParametersByPathRequest request)
Retrieve information about one or more parameters in a specific hierarchy.
|
GetPatchBaselineResult |
getPatchBaseline(GetPatchBaselineRequest request)
Retrieves information about a patch baseline.
|
GetPatchBaselineForPatchGroupResult |
getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest request)
Retrieves the patch baseline that should be used for the specified patch group.
|
GetServiceSettingResult |
getServiceSetting(GetServiceSettingRequest request)
ServiceSetting is an account-level setting for an Amazon Web Services service. |
LabelParameterVersionResult |
labelParameterVersion(LabelParameterVersionRequest request)
A parameter label is a user-defined alias to help you manage different versions of a parameter.
|
ListAssociationsResult |
listAssociations(ListAssociationsRequest request)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region.
|
ListAssociationVersionsResult |
listAssociationVersions(ListAssociationVersionsRequest request)
Retrieves all versions of an association for a specific association ID.
|
ListCommandInvocationsResult |
listCommandInvocations(ListCommandInvocationsRequest request)
An invocation is copy of a command sent to a specific managed node.
|
ListCommandsResult |
listCommands(ListCommandsRequest request)
Lists the commands requested by users of the Amazon Web Services account.
|
ListComplianceItemsResult |
listComplianceItems(ListComplianceItemsRequest request)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource
types.
|
ListComplianceSummariesResult |
listComplianceSummaries(ListComplianceSummariesRequest request)
Returns a summary count of compliant and non-compliant resources for a compliance type.
|
ListDocumentMetadataHistoryResult |
listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest request)
Information about approval reviews for a version of a change template in Change Manager.
|
ListDocumentsResult |
listDocuments()
Simplified method form for invoking the ListDocuments operation.
|
ListDocumentsResult |
listDocuments(ListDocumentsRequest request)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services
Region.
|
ListDocumentVersionsResult |
listDocumentVersions(ListDocumentVersionsRequest request)
List all versions for a document.
|
ListInventoryEntriesResult |
listInventoryEntries(ListInventoryEntriesRequest request)
A list of inventory items returned by the request.
|
ListOpsItemEventsResult |
listOpsItemEvents(ListOpsItemEventsRequest request)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account.
|
ListOpsItemRelatedItemsResult |
listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest request)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem.
|
ListOpsMetadataResult |
listOpsMetadata(ListOpsMetadataRequest request)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata
objects or blobs.
|
ListResourceComplianceSummariesResult |
listResourceComplianceSummaries(ListResourceComplianceSummariesRequest request)
Returns a resource-level summary count.
|
ListResourceDataSyncResult |
listResourceDataSync(ListResourceDataSyncRequest request)
Lists your resource data sync configurations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags assigned to the specified resource.
|
ModifyDocumentPermissionResult |
modifyDocumentPermission(ModifyDocumentPermissionRequest request)
Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately.
|
PutComplianceItemsResult |
putComplianceItems(PutComplianceItemsRequest request)
Registers a compliance type and other compliance details on a designated resource.
|
PutInventoryResult |
putInventory(PutInventoryRequest request)
Bulk update custom inventory items on one or more managed nodes.
|
PutParameterResult |
putParameter(PutParameterRequest request)
Add a parameter to the system.
|
RegisterDefaultPatchBaselineResult |
registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request)
Defines the default patch baseline for the relevant operating system.
|
RegisterPatchBaselineForPatchGroupResult |
registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request)
Registers a patch baseline for a patch group.
|
RegisterTargetWithMaintenanceWindowResult |
registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request)
Registers a target with a maintenance window.
|
RegisterTaskWithMaintenanceWindowResult |
registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request)
Adds a new task to a maintenance window.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes tag keys from the specified resource.
|
ResetServiceSettingResult |
resetServiceSetting(ResetServiceSettingRequest request)
ServiceSetting is an account-level setting for an Amazon Web Services service. |
ResumeSessionResult |
resumeSession(ResumeSessionRequest request)
Reconnects a session to a managed node after it has been disconnected.
|
SendAutomationSignalResult |
sendAutomationSignal(SendAutomationSignalRequest request)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
|
SendCommandResult |
sendCommand(SendCommandRequest request)
Runs commands on one or more managed nodes.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAssociationsOnceResult |
startAssociationsOnce(StartAssociationsOnceRequest request)
Runs an association immediately and only one time.
|
StartAutomationExecutionResult |
startAutomationExecution(StartAutomationExecutionRequest request)
Initiates execution of an Automation runbook.
|
StartChangeRequestExecutionResult |
startChangeRequestExecution(StartChangeRequestExecutionRequest request)
Creates a change request for Change Manager.
|
StartSessionResult |
startSession(StartSessionRequest request)
Initiates a connection to a target (for example, a managed node) for a Session Manager session.
|
StopAutomationExecutionResult |
stopAutomationExecution(StopAutomationExecutionRequest request)
Stop an Automation that is currently running.
|
TerminateSessionResult |
terminateSession(TerminateSessionRequest request)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the
managed node.
|
UnlabelParameterVersionResult |
unlabelParameterVersion(UnlabelParameterVersionRequest request)
Remove a label or labels from a parameter.
|
UpdateAssociationResult |
updateAssociation(UpdateAssociationRequest request)
Updates an association.
|
UpdateAssociationStatusResult |
updateAssociationStatus(UpdateAssociationStatusRequest request)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the
specified managed node.
|
UpdateDocumentResult |
updateDocument(UpdateDocumentRequest request)
Updates one or more values for an SSM document.
|
UpdateDocumentDefaultVersionResult |
updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest request)
Set the default version of a document.
|
UpdateDocumentMetadataResult |
updateDocumentMetadata(UpdateDocumentMetadataRequest request)
Updates information related to approval reviews for a specific version of a change template in Change Manager.
|
UpdateMaintenanceWindowResult |
updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)
Updates an existing maintenance window.
|
UpdateMaintenanceWindowTargetResult |
updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest request)
Modifies the target of an existing maintenance window.
|
UpdateMaintenanceWindowTaskResult |
updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest request)
Modifies a task assigned to a maintenance window.
|
UpdateManagedInstanceRoleResult |
updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request)
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or
virtual machines (VM).
|
UpdateOpsItemResult |
updateOpsItem(UpdateOpsItemRequest request)
Edit or change an OpsItem.
|
UpdateOpsMetadataResult |
updateOpsMetadata(UpdateOpsMetadataRequest request)
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
|
UpdatePatchBaselineResult |
updatePatchBaseline(UpdatePatchBaselineRequest request)
Modifies an existing patch baseline.
|
UpdateResourceDataSyncResult |
updateResourceDataSync(UpdateResourceDataSyncRequest request)
Update a resource data sync.
|
UpdateServiceSettingResult |
updateServiceSetting(UpdateServiceSettingRequest request)
ServiceSetting is an account-level setting for an Amazon Web Services service. |
AWSSimpleSystemsManagementWaiters |
waiters() |
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
protected static final ClientConfigurationFactory configFactory
@Deprecated public AWSSimpleSystemsManagementClient()
AWSSimpleSystemsManagementClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSSimpleSystemsManagementClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for
example:
AWSSimpleSystemsManagementClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).@Deprecated public AWSSimpleSystemsManagementClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SSM (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSSimpleSystemsManagementClientBuilder builder()
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your 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
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.
For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide.
addTagsToResource
in interface AWSSimpleSystemsManagement
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.public AssociateOpsItemRelatedItemResult associateOpsItemRelatedItem(AssociateOpsItemRelatedItemRequest request)
Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of Amazon Web Services Systems Manager.
associateOpsItemRelatedItem
in interface AWSSimpleSystemsManagement
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. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.OpsItemRelatedItemAlreadyExistsException
- The Amazon Resource Name (ARN) is already associated with the OpsItem.public CancelCommandResult cancelCommand(CancelCommandRequest request)
Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelCommand
in interface AWSSimpleSystemsManagement
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 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.public CancelMaintenanceWindowExecutionResult cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest request)
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.
cancelMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
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.
public CreateActivationResult createActivation(CreateActivationRequest request)
Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. 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 environments in the Amazon Web Services Systems Manager User Guide.
Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.
createActivation
in interface AWSSimpleSystemsManagement
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.public CreateAssociationResult createAssociation(CreateAssociationRequest request)
A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.
createAssociation
in interface AWSSimpleSystemsManagement
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 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 ID(s). 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.public CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest request)
Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.
When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.
If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatch
in interface AWSSimpleSystemsManagement
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 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 ID(s). 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.public CreateDocumentResult createDocument(CreateDocumentRequest request)
Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs on your managed nodes. For more information about SSM documents, including information about supported schemas, features, and syntax, see Amazon Web Services Systems Manager Documents in the Amazon Web Services Systems Manager User Guide.
createDocument
in interface AWSSimpleSystemsManagement
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.public CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest request)
Creates a new maintenance window.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
createMaintenanceWindow
in interface AWSSimpleSystemsManagement
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.public CreateOpsItemResult createOpsItem(CreateOpsItemRequest request)
Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.
createOpsItem
in interface AWSSimpleSystemsManagement
createOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemAlreadyExistsException
- The OpsItem already exists.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.public CreateOpsMetadataResult createOpsMetadata(CreateOpsMetadataRequest request)
If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
createOpsMetadata
in interface AWSSimpleSystemsManagement
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.public CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest request)
Creates a patch baseline.
For information about valid key-value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaseline
in interface AWSSimpleSystemsManagement
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.public CreateResourceDataSyncResult createResourceDataSync(CreateResourceDataSyncRequest request)
A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems
Manager offers two types of resource data sync: SyncToDestination
and SyncFromSource
.
You can configure Systems Manager Inventory to use the SyncToDestination
type to synchronize
Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3)
bucket. For more information, see Configuring
resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.
You can configure Systems Manager Explorer to use the SyncFromSource
type to synchronize operational
work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon
S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon
Web Services Regions or EntireOrganization
by using Organizations. For more information, see Setting up
Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services
Systems Manager User Guide.
A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.
By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.
createResourceDataSync
in interface AWSSimpleSystemsManagement
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.public DeleteActivationResult deleteActivation(DeleteActivationRequest request)
Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.
deleteActivation
in interface AWSSimpleSystemsManagement
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.public DeleteAssociationResult deleteAssociation(DeleteAssociationRequest request)
Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified
managed node. If you created the association by using the Targets
parameter, then you must delete
the association by using the association ID.
When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.
deleteAssociation
in interface AWSSimpleSystemsManagement
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 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.public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.
deleteDocument
in interface AWSSimpleSystemsManagement
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.public DeleteInventoryResult deleteInventory(DeleteInventoryRequest request)
Delete a custom inventory type or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteInventory
in interface AWSSimpleSystemsManagement
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.public DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
Deletes a maintenance window.
deleteMaintenanceWindow
in interface AWSSimpleSystemsManagement
deleteMaintenanceWindowRequest
- InternalServerErrorException
- An error occurred on the server side.public DeleteOpsMetadataResult deleteOpsMetadata(DeleteOpsMetadataRequest request)
Delete OpsMetadata related to an application.
deleteOpsMetadata
in interface AWSSimpleSystemsManagement
deleteOpsMetadataRequest
- OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.public DeleteParameterResult deleteParameter(DeleteParameterRequest request)
Delete a parameter from the system. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParameter
in interface AWSSimpleSystemsManagement
deleteParameterRequest
- InternalServerErrorException
- An error occurred on the server side.ParameterNotFoundException
- The parameter couldn't be found. Verify the name and try again.public DeleteParametersResult deleteParameters(DeleteParametersRequest request)
Delete a list of parameters. After deleting a parameter, wait for at least 30 seconds to create a parameter with the same name.
deleteParameters
in interface AWSSimpleSystemsManagement
deleteParametersRequest
- InternalServerErrorException
- An error occurred on the server side.public DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest request)
Deletes a patch baseline.
deletePatchBaseline
in interface AWSSimpleSystemsManagement
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.public DeleteResourceDataSyncResult deleteResourceDataSync(DeleteResourceDataSyncRequest request)
Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
deleteResourceDataSync
in interface AWSSimpleSystemsManagement
deleteResourceDataSyncRequest
- InternalServerErrorException
- An error occurred on the server side.ResourceDataSyncNotFoundException
- The specified sync name wasn't found.ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.public DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest request)
Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstance
in interface AWSSimpleSystemsManagement
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 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.public DeregisterPatchBaselineForPatchGroupResult deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest request)
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
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.public DeregisterTargetFromMaintenanceWindowResult deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest request)
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindow
in interface AWSSimpleSystemsManagement
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.public DeregisterTaskFromMaintenanceWindowResult deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest request)
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindow
in interface AWSSimpleSystemsManagement
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.public DescribeActivationsResult describeActivations(DescribeActivationsRequest request)
Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.
describeActivations
in interface AWSSimpleSystemsManagement
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.public DescribeAssociationResult describeAssociation(DescribeAssociationRequest request)
Describes the association for the specified target or managed node. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID.
describeAssociation
in interface AWSSimpleSystemsManagement
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 valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
public DescribeAssociationExecutionTargetsResult describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest request)
Views information about a specific execution of a specific association.
describeAssociationExecutionTargets
in interface AWSSimpleSystemsManagement
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.public DescribeAssociationExecutionsResult describeAssociationExecutions(DescribeAssociationExecutionsRequest request)
Views all executions for a specific association ID.
describeAssociationExecutions
in interface AWSSimpleSystemsManagement
describeAssociationExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.AssociationDoesNotExistException
- The specified association doesn't exist.InvalidNextTokenException
- The specified token isn't valid.public DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest request)
Provides details about all active and terminated Automation executions.
describeAutomationExecutions
in interface AWSSimpleSystemsManagement
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.public DescribeAutomationStepExecutionsResult describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest request)
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutions
in interface AWSSimpleSystemsManagement
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.public DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest request)
Lists all patches eligible to be included in a patch baseline.
describeAvailablePatches
in interface AWSSimpleSystemsManagement
describeAvailablePatchesRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeDocumentResult describeDocument(DescribeDocumentRequest request)
Describes the specified Amazon Web Services Systems Manager document (SSM document).
describeDocument
in interface AWSSimpleSystemsManagement
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.public DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest request)
Describes the permissions for a Amazon Web Services Systems Manager document (SSM document). If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's Amazon Web Services account ID) or publicly (All).
describeDocumentPermission
in interface AWSSimpleSystemsManagement
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.public DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest request)
All associations for the managed node(s).
describeEffectiveInstanceAssociations
in interface AWSSimpleSystemsManagement
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 valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidNextTokenException
- The specified token isn't valid.public DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest request)
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Applies to patch baselines for Windows only.
describeEffectivePatchesForPatchBaseline
in interface AWSSimpleSystemsManagement
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.public DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest request)
The status of the associations for the managed node(s).
describeInstanceAssociationsStatus
in interface AWSSimpleSystemsManagement
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 valid state. Valid states are: Running
, Pending
,
Stopped
, and Stopping
. Invalid states are: Shutting-down
and
Terminated
.
InvalidNextTokenException
- The specified token isn't valid.public DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest request)
Describes one or more of your managed nodes, including information about the operating system platform, the version of SSM Agent installed on the managed node, node status, and so on.
If you specify one or more managed node IDs, it 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 for this API operation is the Identity and Access Management (IAM) role assigned
to on-premises managed nodes. This call doesn't return the IAM role for EC2 instances.
describeInstanceInformation
in interface AWSSimpleSystemsManagement
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 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.public DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest request)
Retrieves the high-level patch state of one or more managed nodes.
describeInstancePatchStates
in interface AWSSimpleSystemsManagement
describeInstancePatchStatesRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.public DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest request)
Retrieves the high-level patch state for the managed nodes in the specified patch group.
describeInstancePatchStatesForPatchGroup
in interface AWSSimpleSystemsManagement
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.public DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest request)
Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.
describeInstancePatches
in interface AWSSimpleSystemsManagement
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 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.public DescribeInventoryDeletionsResult describeInventoryDeletions(DescribeInventoryDeletionsRequest request)
Describes a specific delete inventory operation.
describeInventoryDeletions
in interface AWSSimpleSystemsManagement
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.public DescribeMaintenanceWindowExecutionTaskInvocationsResult describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request)
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocations
in interface AWSSimpleSystemsManagement
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.public DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request)
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasks
in interface AWSSimpleSystemsManagement
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.public DescribeMaintenanceWindowExecutionsResult describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest request)
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
describeMaintenanceWindowExecutions
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowExecutionsRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeMaintenanceWindowScheduleResult describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest request)
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowSchedule
in interface AWSSimpleSystemsManagement
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.
public DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request)
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargets
in interface AWSSimpleSystemsManagement
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.public DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request)
Lists the tasks in a maintenance window.
For maintenance window tasks without a specified target, you can't supply values for --max-errors
and --max-concurrency
. Instead, the system inserts a placeholder value of 1
, which may
be reported in the response to this command. These values don't affect the running of your task and can be
ignored.
describeMaintenanceWindowTasks
in interface AWSSimpleSystemsManagement
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.public DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest request)
Retrieves the maintenance windows in an Amazon Web Services account.
describeMaintenanceWindows
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowsRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeMaintenanceWindowsForTargetResult describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest request)
Retrieves information about the maintenance window targets or tasks that a managed node is associated with.
describeMaintenanceWindowsForTarget
in interface AWSSimpleSystemsManagement
describeMaintenanceWindowsForTargetRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeOpsItemsResult describeOpsItems(DescribeOpsItemsRequest request)
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 Getting started with 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 OpsCenter in the Amazon Web Services Systems Manager User Guide.
describeOpsItems
in interface AWSSimpleSystemsManagement
describeOpsItemsRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeParametersResult describeParameters(DescribeParametersRequest request)
Get information about a parameter.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, DescribeParameters
retrieves whatever the
original key alias was referencing.
describeParameters
in interface AWSSimpleSystemsManagement
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.public DescribePatchBaselinesResult describePatchBaselines(DescribePatchBaselinesRequest request)
Lists the patch baselines in your Amazon Web Services account.
describePatchBaselines
in interface AWSSimpleSystemsManagement
describePatchBaselinesRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribePatchGroupStateResult describePatchGroupState(DescribePatchGroupStateRequest request)
Returns high-level aggregated patch compliance state information for a patch group.
describePatchGroupState
in interface AWSSimpleSystemsManagement
describePatchGroupStateRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.public DescribePatchGroupsResult describePatchGroups(DescribePatchGroupsRequest request)
Lists all patch groups that have been registered with patch baselines.
describePatchGroups
in interface AWSSimpleSystemsManagement
describePatchGroupsRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribePatchPropertiesResult describePatchProperties(DescribePatchPropertiesRequest request)
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| PRIORITY
Valid properties: PRODUCT
| CLASSIFICATION
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| CLASSIFICATION
| SEVERITY
Valid properties: PRODUCT
| PRIORITY
Valid properties: PRODUCT
| PRODUCT_FAMILY
| CLASSIFICATION
|
MSRC_SEVERITY
describePatchProperties
in interface AWSSimpleSystemsManagement
describePatchPropertiesRequest
- InternalServerErrorException
- An error occurred on the server side.public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessions
in interface AWSSimpleSystemsManagement
describeSessionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidFilterKeyException
- The specified key isn't valid.InvalidNextTokenException
- The specified token isn't valid.public DisassociateOpsItemRelatedItemResult disassociateOpsItemRelatedItem(DisassociateOpsItemRelatedItemRequest request)
Deletes the association between an OpsItem and a related item. For example, this API operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of Amazon Web Services Systems Manager.
disassociateOpsItemRelatedItem
in interface AWSSimpleSystemsManagement
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.public GetAutomationExecutionResult getAutomationExecution(GetAutomationExecutionRequest request)
Get detailed information about a particular Automation execution.
getAutomationExecution
in interface AWSSimpleSystemsManagement
getAutomationExecutionRequest
- AutomationExecutionNotFoundException
- There is no automation execution information for the requested automation execution ID.InternalServerErrorException
- An error occurred on the server side.public GetCalendarStateResult getCalendarState(GetCalendarStateRequest request)
Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time.
If you specify a time, GetCalendarState
returns the state of the calendar at that specific time, and
returns the next time that the change calendar state will transition. If you don't specify a time,
GetCalendarState
uses the current time. Change Calendar entries have two possible states:
OPEN
or CLOSED
.
If you specify more than one calendar in a request, the command returns the status of OPEN
only if
all calendars in the request are open. If one or more calendars in the request are closed, the status returned is
CLOSED
.
For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
getCalendarState
in interface AWSSimpleSystemsManagement
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.public GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest request)
Returns detailed information about command execution for an invocation or plugin.
GetCommandInvocation
only gives the execution status of a plugin in a document. To get the command
execution status on a specific managed node, use ListCommandInvocations. To get the command execution
status across managed nodes, use ListCommands.
getCommandInvocation
in interface AWSSimpleSystemsManagement
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 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.public GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest request)
Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.
getConnectionStatus
in interface AWSSimpleSystemsManagement
getConnectionStatusRequest
- InternalServerErrorException
- An error occurred on the server side.public GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest request)
Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you don't specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
getDefaultPatchBaselineRequest
- InternalServerErrorException
- An error occurred on the server side.public GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest request)
Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the
AWS-RunPatchBaseline
Systems Manager document (SSM document).
If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your
local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the
Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems
Manager, with an SSM document that enables you to target a managed node with a script or command. For example,
run the command using the AWS-RunShellScript
document or the AWS-RunPowerShellScript
document.
getDeployablePatchSnapshotForInstance
in interface AWSSimpleSystemsManagement
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 Enabling the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.public GetDocumentResult getDocument(GetDocumentRequest request)
Gets the contents of the specified Amazon Web Services Systems Manager document (SSM document).
getDocument
in interface AWSSimpleSystemsManagement
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.public GetInventoryResult getInventory(GetInventoryRequest request)
Query inventory information. This includes managed node status, such as Stopped
or
Terminated
.
getInventory
in interface AWSSimpleSystemsManagement
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.public GetInventorySchemaResult getInventorySchema(GetInventorySchemaRequest request)
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchema
in interface AWSSimpleSystemsManagement
getInventorySchemaRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidTypeNameException
- The parameter type name isn't valid.InvalidNextTokenException
- The specified token isn't valid.public GetMaintenanceWindowResult getMaintenanceWindow(GetMaintenanceWindowRequest request)
Retrieves a maintenance window.
getMaintenanceWindow
in interface AWSSimpleSystemsManagement
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.public GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request)
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
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.public GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request)
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTask
in interface AWSSimpleSystemsManagement
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.public GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest request)
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocation
in interface AWSSimpleSystemsManagement
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.public GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request)
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.
getMaintenanceWindowTask
in interface AWSSimpleSystemsManagement
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.public GetOpsItemResult getOpsItem(GetOpsItemRequest request)
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 Getting started with 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 OpsCenter in the Amazon Web Services Systems Manager User Guide.
getOpsItem
in interface AWSSimpleSystemsManagement
getOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.public GetOpsMetadataResult getOpsMetadata(GetOpsMetadataRequest request)
View operational metadata related to an application in Application Manager.
getOpsMetadata
in interface AWSSimpleSystemsManagement
getOpsMetadataRequest
- OpsMetadataNotFoundException
- The OpsMetadata object doesn't exist.OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.public GetOpsSummaryResult getOpsSummary(GetOpsSummaryRequest request)
View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.
getOpsSummary
in interface AWSSimpleSystemsManagement
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
.public GetParameterResult getParameter(GetParameterRequest request)
Get information about a single parameter by specifying the parameter name.
To get information about more than one parameter at a time, use the GetParameters operation.
getParameter
in interface AWSSimpleSystemsManagement
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.public GetParameterHistoryResult getParameterHistory(GetParameterHistoryRequest request)
Retrieves the history of all changes to a parameter.
If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key
alias the parameter uses to reference KMS. Otherwise, GetParameterHistory
retrieves whatever the
original key alias was referencing.
getParameterHistory
in interface AWSSimpleSystemsManagement
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.public GetParametersResult getParameters(GetParametersRequest request)
Get information about one or more parameters by specifying multiple parameter names.
To get information about a single parameter, you can use the GetParameter operation instead.
getParameters
in interface AWSSimpleSystemsManagement
getParametersRequest
- InvalidKeyIdException
- The query key ID isn't valid.InternalServerErrorException
- An error occurred on the server side.public GetParametersByPathResult getParametersByPath(GetParametersByPathRequest request)
Retrieve information about one or more parameters in a specific hierarchy.
Request results are returned on a best-effort basis. If you specify MaxResults
in the request, the
response includes information up to the limit specified. The number of items returned, however, can be between
zero and the value of MaxResults
. If the service reaches an internal limit while processing the
results, it stops the operation and returns the matching values up to that point and a NextToken
.
You can specify the NextToken
in a subsequent call to get the next set of results.
getParametersByPath
in interface AWSSimpleSystemsManagement
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.public GetPatchBaselineResult getPatchBaseline(GetPatchBaselineRequest request)
Retrieves information about a patch baseline.
getPatchBaseline
in interface AWSSimpleSystemsManagement
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.public GetPatchBaselineForPatchGroupResult getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest request)
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
getPatchBaselineForPatchGroupRequest
- InternalServerErrorException
- An error occurred on the server side.public GetServiceSettingResult getServiceSetting(GetServiceSettingRequest request)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services service team
might create a default setting of false
. This means the user can't use this feature unless they
change the setting to true
and intentionally opt in for a paid feature.
Services map a SettingId
object to a setting value. Amazon Web Services services teams define the
default value for a SettingId
. You can't create a new SettingId
, but you can overwrite
the default value if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the Amazon Web Services service team.
Query the current service setting for the Amazon Web Services account.
getServiceSetting
in interface AWSSimpleSystemsManagement
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.public LabelParameterVersionResult labelParameterVersion(LabelParameterVersionRequest request)
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws
" or "ssm
" (not case sensitive). If a label fails
to meet these requirements, then the label isn't associated with a parameter and the system displays it in the
list of InvalidLabels.
labelParameterVersion
in interface AWSSimpleSystemsManagement
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.public ListAssociationVersionsResult listAssociationVersions(ListAssociationVersionsRequest request)
Retrieves all versions of an association for a specific association ID.
listAssociationVersions
in interface AWSSimpleSystemsManagement
listAssociationVersionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.AssociationDoesNotExistException
- The specified association doesn't exist.public ListAssociationsResult listAssociations(ListAssociationsRequest request)
Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.
listAssociations
in interface AWSSimpleSystemsManagement
listAssociationsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.public ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest request)
An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed
nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand
against three managed nodes, then a command invocation is created for each requested managed node ID.
ListCommandInvocations
provide status about command execution.
listCommandInvocations
in interface AWSSimpleSystemsManagement
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 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.public ListCommandsResult listCommands(ListCommandsRequest request)
Lists the commands requested by users of the Amazon Web Services account.
listCommands
in interface AWSSimpleSystemsManagement
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 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.public ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest request)
For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItems
in interface AWSSimpleSystemsManagement
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.public ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest request)
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
listComplianceSummaries
in interface AWSSimpleSystemsManagement
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.public ListDocumentMetadataHistoryResult listDocumentMetadataHistory(ListDocumentMetadataHistoryRequest request)
Information about approval reviews for a version of a change template in Change Manager.
listDocumentMetadataHistory
in interface AWSSimpleSystemsManagement
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.public ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest request)
List all versions for a document.
listDocumentVersions
in interface AWSSimpleSystemsManagement
listDocumentVersionsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidDocumentException
- The specified SSM document doesn't exist.public ListDocumentsResult listDocuments(ListDocumentsRequest request)
Returns all Systems Manager (SSM) documents in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results of this request by using a filter.
listDocuments
in interface AWSSimpleSystemsManagement
listDocumentsRequest
- InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.InvalidFilterKeyException
- The specified key isn't valid.public ListDocumentsResult listDocuments()
AWSSimpleSystemsManagement
listDocuments
in interface AWSSimpleSystemsManagement
AWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)
public ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest request)
A list of inventory items returned by the request.
listInventoryEntries
in interface AWSSimpleSystemsManagement
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 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.public ListOpsItemEventsResult listOpsItemEvents(ListOpsItemEventsRequest request)
Returns a list of all OpsItem events in the current Amazon Web Services Region and Amazon Web Services account. You can limit the results to events associated with specific OpsItems by specifying a filter.
listOpsItemEvents
in interface AWSSimpleSystemsManagement
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. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.public ListOpsItemRelatedItemsResult listOpsItemRelatedItems(ListOpsItemRelatedItemsRequest request)
Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a capability of Amazon Web Services Systems Manager.
listOpsItemRelatedItems
in interface AWSSimpleSystemsManagement
listOpsItemRelatedItemsRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.public ListOpsMetadataResult listOpsMetadata(ListOpsMetadataRequest request)
Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
listOpsMetadata
in interface AWSSimpleSystemsManagement
listOpsMetadataRequest
- OpsMetadataInvalidArgumentException
- One of the arguments passed is invalid.InternalServerErrorException
- An error occurred on the server side.public ListResourceComplianceSummariesResult listResourceComplianceSummaries(ListResourceComplianceSummariesRequest request)
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
listResourceComplianceSummaries
in interface AWSSimpleSystemsManagement
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.public ListResourceDataSyncResult listResourceDataSync(ListResourceDataSyncRequest request)
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
listResourceDataSync
in interface AWSSimpleSystemsManagement
listResourceDataSyncRequest
- ResourceDataSyncInvalidConfigurationException
- The specified sync configuration is invalid.InternalServerErrorException
- An error occurred on the server side.InvalidNextTokenException
- The specified token isn't valid.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of the tags assigned to the specified resource.
For information about the ID format for each supported resource type, see AddTagsToResource.
listTagsForResource
in interface AWSSimpleSystemsManagement
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.public ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest request)
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 account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermission
in interface AWSSimpleSystemsManagement
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 user accounts. You can share a document with a
maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit,
contact Amazon Web Services Support.DocumentLimitExceededException
- You can have at most 500 active SSM documents.public PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest request)
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, critical
.
DocumentName: An SSM document name. For example, AWS-RunPatchBaseline
.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItems
in interface AWSSimpleSystemsManagement
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.public PutInventoryResult putInventory(PutInventoryRequest request)
Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventory
in interface AWSSimpleSystemsManagement
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 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.public PutParameterResult putParameter(PutParameterRequest request)
Add a parameter to the system.
putParameter
in interface AWSSimpleSystemsManagement
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.public RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request)
Defines the default patch baseline for the relevant operating system.
To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon
Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
registerDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
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.public RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request)
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
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.public RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request)
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
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.public RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request)
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
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.public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes tag keys from the specified resource.
removeTagsFromResource
in interface AWSSimpleSystemsManagement
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.public ResetServiceSettingResult resetServiceSetting(ResetServiceSettingRequest request)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services service team
might create a default setting of "false". This means the user can't use this feature unless they change the
setting to "true" and intentionally opt in for a paid feature.
Services map a SettingId
object to a setting value. Amazon Web Services services teams define the
default value for a SettingId
. You can't create a new SettingId
, but you can overwrite
the default value if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API
operation to change the default setting.
Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.
resetServiceSetting
in interface AWSSimpleSystemsManagement
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.public ResumeSessionResult resumeSession(ResumeSessionRequest request)
Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.
resumeSession
in interface AWSSimpleSystemsManagement
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.public SendAutomationSignalResult sendAutomationSignal(SendAutomationSignalRequest request)
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignal
in interface AWSSimpleSystemsManagement
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.public SendCommandResult sendCommand(SendCommandRequest request)
Runs commands on one or more managed nodes.
sendCommand
in interface AWSSimpleSystemsManagement
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 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 ID(s). 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 Configuring
Amazon SNS Notifications for Run Command 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.public StartAssociationsOnceResult startAssociationsOnce(StartAssociationsOnceRequest request)
Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.
startAssociationsOnce
in interface AWSSimpleSystemsManagement
startAssociationsOnceRequest
- InvalidAssociationException
- The association isn't valid or doesn't exist.AssociationDoesNotExistException
- The specified association doesn't exist.public StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest request)
Initiates execution of an Automation runbook.
startAutomationExecution
in interface AWSSimpleSystemsManagement
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.public StartChangeRequestExecutionResult startChangeRequestExecution(StartChangeRequestExecutionRequest request)
Creates a change request for Change Manager. The Automation runbooks specified in the change request run only after all required approvals for the change request have been received.
startChangeRequestExecution
in interface AWSSimpleSystemsManagement
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.public StartSessionResult startSession(StartSessionRequest request)
Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
Amazon Web Services CLI usage: start-session
is an interactive command that requires the Session
Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems
Manager User Guide.
Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.
startSession
in interface AWSSimpleSystemsManagement
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.public StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest request)
Stop an Automation that is currently running.
stopAutomationExecution
in interface AWSSimpleSystemsManagement
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.public TerminateSessionResult terminateSession(TerminateSessionRequest request)
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session isn't be resumed.
terminateSession
in interface AWSSimpleSystemsManagement
terminateSessionRequest
- DoesNotExistException
- Error returned when the ID specified for a resource, such as a maintenance window or patch baseline,
doesn't exist.
For information about resource quotas in 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.public UnlabelParameterVersionResult unlabelParameterVersion(UnlabelParameterVersionRequest request)
Remove a label or labels from a parameter.
unlabelParameterVersion
in interface AWSSimpleSystemsManagement
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.public UpdateAssociationResult updateAssociation(UpdateAssociationRequest request)
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output.
In order to call this API operation, your Identity and Access Management (IAM) user account, group, or role must
be configured with 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.
updateAssociation
in interface AWSSimpleSystemsManagement
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.public UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest request)
Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.
UpdateAssociationStatus
is primarily used by the Amazon Web Services Systems Manager Agent (SSM
Agent) to report status updates about your associations and is only used for associations created with the
InstanceId
legacy parameter.
updateAssociationStatus
in interface AWSSimpleSystemsManagement
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 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.public UpdateDocumentResult updateDocument(UpdateDocumentRequest request)
Updates one or more values for an SSM document.
updateDocument
in interface AWSSimpleSystemsManagement
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.public UpdateDocumentDefaultVersionResult updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest request)
Set the default version of a document.
updateDocumentDefaultVersion
in interface AWSSimpleSystemsManagement
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.public UpdateDocumentMetadataResult updateDocumentMetadata(UpdateDocumentMetadataRequest request)
Updates information related to approval reviews for a specific version of a change template in Change Manager.
updateDocumentMetadata
in interface AWSSimpleSystemsManagement
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.public UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)
Updates an existing maintenance window. Only specified parameters are modified.
The value you specify for Duration
determines the specific end time for the maintenance window based
on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the
number of hours you specify for Cutoff
. For example, if the maintenance window starts at 3 PM, the
duration is three hours, and the value you specify for Cutoff
is one hour, no maintenance window
tasks can start after 5 PM.
updateMaintenanceWindow
in interface AWSSimpleSystemsManagement
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.public UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest request)
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field isn't modified.
updateMaintenanceWindowTarget
in interface AWSSimpleSystemsManagement
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.public UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest request)
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN
. For example, you can change a RUN_COMMAND
task from
AWS-RunPowerShellScript
to AWS-RunShellScript
.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.
If the value for a parameter in UpdateMaintenanceWindowTask
is null, then the corresponding field
isn't modified. If you set Replace
to true, then all fields required by the
RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't
specified are set to null.
When you update a maintenance window task that has options specified in TaskInvocationParameters
,
you must provide again all the TaskInvocationParameters
values that you want to retain. The values
you don't specify again are removed. For example, suppose that when you registered a Run Command task, you
specified TaskInvocationParameters
values for Comment
, NotificationConfig
,
and OutputS3BucketName
. If you update the maintenance window task and specify only a different
OutputS3BucketName
value, the values for Comment
and NotificationConfig
are removed.
updateMaintenanceWindowTask
in interface AWSSimpleSystemsManagement
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.public UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request)
Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.
updateManagedInstanceRole
in interface AWSSimpleSystemsManagement
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 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.public UpdateOpsItemResult updateOpsItem(UpdateOpsItemRequest request)
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with 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 OpsCenter in the Amazon Web Services Systems Manager User Guide.
updateOpsItem
in interface AWSSimpleSystemsManagement
updateOpsItemRequest
- InternalServerErrorException
- An error occurred on the server side.OpsItemNotFoundException
- The specified OpsItem ID doesn't exist. Verify the ID and try again.OpsItemAlreadyExistsException
- The OpsItem already exists.OpsItemLimitExceededException
- The request caused OpsItems to exceed one or more quotas. For information about OpsItem quotas, see What are the resource limits for OpsCenter?.OpsItemInvalidParameterException
- A specified parameter argument isn't valid. Verify the available arguments and try again.public UpdateOpsMetadataResult updateOpsMetadata(UpdateOpsMetadataRequest request)
Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
updateOpsMetadata
in interface AWSSimpleSystemsManagement
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.public UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest request)
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key-value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
updatePatchBaseline
in interface AWSSimpleSystemsManagement
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.public UpdateResourceDataSyncResult updateResourceDataSync(UpdateResourceDataSyncRequest request)
Update a resource data sync. After you create a resource data sync for a Region, you can't change the account
options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the
Include only the current account
option, you can't edit that sync later and choose the
Include all accounts from my Organizations configuration
option. Instead, you must delete the first
resource data sync, and create a new one.
This API operation only supports a resource data sync that was created with a SyncFromSource
SyncType
.
updateResourceDataSync
in interface AWSSimpleSystemsManagement
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.public UpdateServiceSettingResult updateServiceSetting(UpdateServiceSettingRequest request)
ServiceSetting
is an account-level setting for an Amazon Web Services service. This setting defines
how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services
service charges money to the account based on feature or service usage, then the Amazon Web Services service team
might create a default setting of "false". This means the user can't use this feature unless they change the
setting to "true" and intentionally opt in for a paid feature.
Services map a SettingId
object to a setting value. Amazon Web Services services teams define the
default value for a SettingId
. You can't create a new SettingId
, but you can overwrite
the default value if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to
change the value back to the original value defined by the Amazon Web Services service team.
Update the service setting for the account.
updateServiceSetting
in interface AWSSimpleSystemsManagement
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.public 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 the request.
getCachedResponseMetadata
in interface AWSSimpleSystemsManagement
request
- The originally executed requestpublic AWSSimpleSystemsManagementWaiters waiters()
waiters
in interface AWSSimpleSystemsManagement
public void shutdown()
AWSSimpleSystemsManagement
shutdown
in interface AWSSimpleSystemsManagement
shutdown
in class AmazonWebServiceClient
Copyright © 2021. All rights reserved.