@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSSimpleSystemsManagement extends Object implements AWSSimpleSystemsManagement
AWSSimpleSystemsManagement
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
public void setEndpoint(String endpoint)
AWSSimpleSystemsManagement
Callers can pass in just the endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://ssm.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSSimpleSystemsManagement
endpoint
- The endpoint (ex: "ssm.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://ssm.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSSimpleSystemsManagement
AWSSimpleSystemsManagement.setEndpoint(String)
, sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSSimpleSystemsManagement
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AWSSimpleSystemsManagement
Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.
Each resource can have a maximum of 50 tags.
We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.
For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.
addTagsToResource
in interface AWSSimpleSystemsManagement
public CancelCommandResult cancelCommand(CancelCommandRequest request)
AWSSimpleSystemsManagement
Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.
cancelCommand
in interface AWSSimpleSystemsManagement
public CancelMaintenanceWindowExecutionResult cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest request)
AWSSimpleSystemsManagement
Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)
cancelMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
public CreateActivationResult createActivation(CreateActivationRequest request)
AWSSimpleSystemsManagement
Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up AWS Systems Manager for Hybrid Environments.
createActivation
in interface AWSSimpleSystemsManagement
public CreateAssociationResult createAssociation(CreateAssociationRequest request)
AWSSimpleSystemsManagement
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociation
in interface AWSSimpleSystemsManagement
public CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest request)
AWSSimpleSystemsManagement
Associates the specified Systems Manager document with the specified instances or targets.
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.
createAssociationBatch
in interface AWSSimpleSystemsManagement
public CreateDocumentResult createDocument(CreateDocumentRequest request)
AWSSimpleSystemsManagement
Creates a Systems Manager document.
After you create a document, you can use CreateAssociation to associate it with one or more running instances.
createDocument
in interface AWSSimpleSystemsManagement
public CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Creates a new maintenance window.
createMaintenanceWindow
in interface AWSSimpleSystemsManagement
public CreateOpsItemResult createOpsItem(CreateOpsItemRequest request)
AWSSimpleSystemsManagement
Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
createOpsItem
in interface AWSSimpleSystemsManagement
public CreatePatchBaselineResult createPatchBaseline(CreatePatchBaselineRequest request)
AWSSimpleSystemsManagement
Creates a patch baseline.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
createPatchBaseline
in interface AWSSimpleSystemsManagement
public CreateResourceDataSyncResult createResourceDataSync(CreateResourceDataSyncRequest request)
AWSSimpleSystemsManagement
Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.
By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.
createResourceDataSync
in interface AWSSimpleSystemsManagement
public DeleteActivationResult deleteActivation(DeleteActivationRequest request)
AWSSimpleSystemsManagement
Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.
deleteActivation
in interface AWSSimpleSystemsManagement
public DeleteAssociationResult deleteAssociation(DeleteAssociationRequest request)
AWSSimpleSystemsManagement
Disassociates the specified Systems Manager document from the specified instance.
When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.
deleteAssociation
in interface AWSSimpleSystemsManagement
public DeleteDocumentResult deleteDocument(DeleteDocumentRequest request)
AWSSimpleSystemsManagement
Deletes the Systems Manager document and all instance associations to the document.
Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.
deleteDocument
in interface AWSSimpleSystemsManagement
public DeleteInventoryResult deleteInventory(DeleteInventoryRequest request)
AWSSimpleSystemsManagement
Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.
deleteInventory
in interface AWSSimpleSystemsManagement
public DeleteMaintenanceWindowResult deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Deletes a maintenance window.
deleteMaintenanceWindow
in interface AWSSimpleSystemsManagement
public DeleteParameterResult deleteParameter(DeleteParameterRequest request)
AWSSimpleSystemsManagement
Delete a parameter from the system.
deleteParameter
in interface AWSSimpleSystemsManagement
public DeleteParametersResult deleteParameters(DeleteParametersRequest request)
AWSSimpleSystemsManagement
Delete a list of parameters.
deleteParameters
in interface AWSSimpleSystemsManagement
public DeletePatchBaselineResult deletePatchBaseline(DeletePatchBaselineRequest request)
AWSSimpleSystemsManagement
Deletes a patch baseline.
deletePatchBaseline
in interface AWSSimpleSystemsManagement
public DeleteResourceDataSyncResult deleteResourceDataSync(DeleteResourceDataSyncRequest request)
AWSSimpleSystemsManagement
Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.
deleteResourceDataSync
in interface AWSSimpleSystemsManagement
public DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest request)
AWSSimpleSystemsManagement
Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.
deregisterManagedInstance
in interface AWSSimpleSystemsManagement
public DeregisterPatchBaselineForPatchGroupResult deregisterPatchBaselineForPatchGroup(DeregisterPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagement
Removes a patch group from a patch baseline.
deregisterPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
public DeregisterTargetFromMaintenanceWindowResult deregisterTargetFromMaintenanceWindow(DeregisterTargetFromMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Removes a target from a maintenance window.
deregisterTargetFromMaintenanceWindow
in interface AWSSimpleSystemsManagement
public DeregisterTaskFromMaintenanceWindowResult deregisterTaskFromMaintenanceWindow(DeregisterTaskFromMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Removes a task from a maintenance window.
deregisterTaskFromMaintenanceWindow
in interface AWSSimpleSystemsManagement
public DescribeActivationsResult describeActivations(DescribeActivationsRequest request)
AWSSimpleSystemsManagement
Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.
describeActivations
in interface AWSSimpleSystemsManagement
public DescribeAssociationResult describeAssociation(DescribeAssociationRequest request)
AWSSimpleSystemsManagement
Describes the association for the specified target or instance. If you created the association by using the
Targets
parameter, then you must retrieve the association by using the association ID. If you
created the association by specifying an instance ID and a Systems Manager document, then you retrieve the
association by specifying the document name and the instance ID.
describeAssociation
in interface AWSSimpleSystemsManagement
public DescribeAssociationExecutionTargetsResult describeAssociationExecutionTargets(DescribeAssociationExecutionTargetsRequest request)
AWSSimpleSystemsManagement
Use this API action to view information about a specific execution of a specific association.
describeAssociationExecutionTargets
in interface AWSSimpleSystemsManagement
public DescribeAssociationExecutionsResult describeAssociationExecutions(DescribeAssociationExecutionsRequest request)
AWSSimpleSystemsManagement
Use this API action to view all executions for a specific association ID.
describeAssociationExecutions
in interface AWSSimpleSystemsManagement
public DescribeAutomationExecutionsResult describeAutomationExecutions(DescribeAutomationExecutionsRequest request)
AWSSimpleSystemsManagement
Provides details about all active and terminated Automation executions.
describeAutomationExecutions
in interface AWSSimpleSystemsManagement
public DescribeAutomationStepExecutionsResult describeAutomationStepExecutions(DescribeAutomationStepExecutionsRequest request)
AWSSimpleSystemsManagement
Information about all active and terminated step executions in an Automation workflow.
describeAutomationStepExecutions
in interface AWSSimpleSystemsManagement
public DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest request)
AWSSimpleSystemsManagement
Lists all patches eligible to be included in a patch baseline.
describeAvailablePatches
in interface AWSSimpleSystemsManagement
public DescribeDocumentResult describeDocument(DescribeDocumentRequest request)
AWSSimpleSystemsManagement
Describes the specified Systems Manager document.
describeDocument
in interface AWSSimpleSystemsManagement
public DescribeDocumentPermissionResult describeDocumentPermission(DescribeDocumentPermissionRequest request)
AWSSimpleSystemsManagement
Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).
describeDocumentPermission
in interface AWSSimpleSystemsManagement
public DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest request)
AWSSimpleSystemsManagement
All associations for the instance(s).
describeEffectiveInstanceAssociations
in interface AWSSimpleSystemsManagement
public DescribeEffectivePatchesForPatchBaselineResult describeEffectivePatchesForPatchBaseline(DescribeEffectivePatchesForPatchBaselineRequest request)
AWSSimpleSystemsManagement
Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.
describeEffectivePatchesForPatchBaseline
in interface AWSSimpleSystemsManagement
public DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest request)
AWSSimpleSystemsManagement
The status of the associations for the instance(s).
describeInstanceAssociationsStatus
in interface AWSSimpleSystemsManagement
public DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest request)
AWSSimpleSystemsManagement
Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.
The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.
describeInstanceInformation
in interface AWSSimpleSystemsManagement
public DescribeInstancePatchStatesResult describeInstancePatchStates(DescribeInstancePatchStatesRequest request)
AWSSimpleSystemsManagement
Retrieves the high-level patch state of one or more instances.
describeInstancePatchStates
in interface AWSSimpleSystemsManagement
public DescribeInstancePatchStatesForPatchGroupResult describeInstancePatchStatesForPatchGroup(DescribeInstancePatchStatesForPatchGroupRequest request)
AWSSimpleSystemsManagement
Retrieves the high-level patch state for the instances in the specified patch group.
describeInstancePatchStatesForPatchGroup
in interface AWSSimpleSystemsManagement
public DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest request)
AWSSimpleSystemsManagement
Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.
describeInstancePatches
in interface AWSSimpleSystemsManagement
public DescribeInventoryDeletionsResult describeInventoryDeletions(DescribeInventoryDeletionsRequest request)
AWSSimpleSystemsManagement
Describes a specific delete inventory operation.
describeInventoryDeletions
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowExecutionTaskInvocationsResult describeMaintenanceWindowExecutionTaskInvocations(DescribeMaintenanceWindowExecutionTaskInvocationsRequest request)
AWSSimpleSystemsManagement
Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.
describeMaintenanceWindowExecutionTaskInvocations
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowExecutionTasksResult describeMaintenanceWindowExecutionTasks(DescribeMaintenanceWindowExecutionTasksRequest request)
AWSSimpleSystemsManagement
For a given maintenance window execution, lists the tasks that were run.
describeMaintenanceWindowExecutionTasks
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowExecutionsResult describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest request)
AWSSimpleSystemsManagement
Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.
describeMaintenanceWindowExecutions
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowScheduleResult describeMaintenanceWindowSchedule(DescribeMaintenanceWindowScheduleRequest request)
AWSSimpleSystemsManagement
Retrieves information about upcoming executions of a maintenance window.
describeMaintenanceWindowSchedule
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowTargetsResult describeMaintenanceWindowTargets(DescribeMaintenanceWindowTargetsRequest request)
AWSSimpleSystemsManagement
Lists the targets registered with the maintenance window.
describeMaintenanceWindowTargets
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest request)
AWSSimpleSystemsManagement
Lists the tasks in a maintenance window.
describeMaintenanceWindowTasks
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowsResult describeMaintenanceWindows(DescribeMaintenanceWindowsRequest request)
AWSSimpleSystemsManagement
Retrieves the maintenance windows in an AWS account.
describeMaintenanceWindows
in interface AWSSimpleSystemsManagement
public DescribeMaintenanceWindowsForTargetResult describeMaintenanceWindowsForTarget(DescribeMaintenanceWindowsForTargetRequest request)
AWSSimpleSystemsManagement
Retrieves information about the maintenance window targets or tasks that an instance is associated with.
describeMaintenanceWindowsForTarget
in interface AWSSimpleSystemsManagement
public DescribeOpsItemsResult describeOpsItems(DescribeOpsItemsRequest request)
AWSSimpleSystemsManagement
Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
describeOpsItems
in interface AWSSimpleSystemsManagement
public DescribeParametersResult describeParameters(DescribeParametersRequest request)
AWSSimpleSystemsManagement
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.
describeParameters
in interface AWSSimpleSystemsManagement
public DescribePatchBaselinesResult describePatchBaselines(DescribePatchBaselinesRequest request)
AWSSimpleSystemsManagement
Lists the patch baselines in your AWS account.
describePatchBaselines
in interface AWSSimpleSystemsManagement
public DescribePatchGroupStateResult describePatchGroupState(DescribePatchGroupStateRequest request)
AWSSimpleSystemsManagement
Returns high-level aggregated patch compliance state for a patch group.
describePatchGroupState
in interface AWSSimpleSystemsManagement
public DescribePatchGroupsResult describePatchGroups(DescribePatchGroupsRequest request)
AWSSimpleSystemsManagement
Lists all patch groups that have been registered with patch baselines.
describePatchGroups
in interface AWSSimpleSystemsManagement
public DescribePatchPropertiesResult describePatchProperties(DescribePatchPropertiesRequest request)
AWSSimpleSystemsManagement
Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.
The following section lists the properties that can be used in filters for each major operating system type:
Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, PRIORITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
Valid properties: PRODUCT, CLASSIFICATION, SEVERITY
describePatchProperties
in interface AWSSimpleSystemsManagement
public DescribeSessionsResult describeSessions(DescribeSessionsRequest request)
AWSSimpleSystemsManagement
Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.
describeSessions
in interface AWSSimpleSystemsManagement
public GetAutomationExecutionResult getAutomationExecution(GetAutomationExecutionRequest request)
AWSSimpleSystemsManagement
Get detailed information about a particular Automation execution.
getAutomationExecution
in interface AWSSimpleSystemsManagement
public GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest request)
AWSSimpleSystemsManagement
Returns detailed information about command execution for an invocation or plugin.
getCommandInvocation
in interface AWSSimpleSystemsManagement
public GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest request)
AWSSimpleSystemsManagement
Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.
getConnectionStatus
in interface AWSSimpleSystemsManagement
public GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest request)
AWSSimpleSystemsManagement
Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.
If you do not specify an operating system value, the default patch baseline for Windows is returned.
getDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
public GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest request)
AWSSimpleSystemsManagement
Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.
getDeployablePatchSnapshotForInstance
in interface AWSSimpleSystemsManagement
public GetDocumentResult getDocument(GetDocumentRequest request)
AWSSimpleSystemsManagement
Gets the contents of the specified Systems Manager document.
getDocument
in interface AWSSimpleSystemsManagement
public GetInventoryResult getInventory(GetInventoryRequest request)
AWSSimpleSystemsManagement
Query inventory information.
getInventory
in interface AWSSimpleSystemsManagement
public GetInventorySchemaResult getInventorySchema(GetInventorySchemaRequest request)
AWSSimpleSystemsManagement
Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.
getInventorySchema
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowResult getMaintenanceWindow(GetMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Retrieves a maintenance window.
getMaintenanceWindow
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowExecutionResult getMaintenanceWindowExecution(GetMaintenanceWindowExecutionRequest request)
AWSSimpleSystemsManagement
Retrieves details about a specific a maintenance window execution.
getMaintenanceWindowExecution
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowExecutionTaskResult getMaintenanceWindowExecutionTask(GetMaintenanceWindowExecutionTaskRequest request)
AWSSimpleSystemsManagement
Retrieves the details about a specific task run as part of a maintenance window execution.
getMaintenanceWindowExecutionTask
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowExecutionTaskInvocationResult getMaintenanceWindowExecutionTaskInvocation(GetMaintenanceWindowExecutionTaskInvocationRequest request)
AWSSimpleSystemsManagement
Retrieves information about a specific task running on a specific target.
getMaintenanceWindowExecutionTaskInvocation
in interface AWSSimpleSystemsManagement
public GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest request)
AWSSimpleSystemsManagement
Lists the tasks in a maintenance window.
getMaintenanceWindowTask
in interface AWSSimpleSystemsManagement
public GetOpsItemResult getOpsItem(GetOpsItemRequest request)
AWSSimpleSystemsManagement
Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
getOpsItem
in interface AWSSimpleSystemsManagement
public GetOpsSummaryResult getOpsSummary(GetOpsSummaryRequest request)
AWSSimpleSystemsManagement
View a summary of OpsItems based on specified filters and aggregators.
getOpsSummary
in interface AWSSimpleSystemsManagement
public GetParameterResult getParameter(GetParameterRequest request)
AWSSimpleSystemsManagement
Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.
getParameter
in interface AWSSimpleSystemsManagement
public GetParameterHistoryResult getParameterHistory(GetParameterHistoryRequest request)
AWSSimpleSystemsManagement
Query a list of all parameters used by the AWS account.
getParameterHistory
in interface AWSSimpleSystemsManagement
public GetParametersResult getParameters(GetParametersRequest request)
AWSSimpleSystemsManagement
Get details of a parameter. Don't confuse this API action with the GetParameter API action.
getParameters
in interface AWSSimpleSystemsManagement
public GetParametersByPathResult getParametersByPath(GetParametersByPathRequest request)
AWSSimpleSystemsManagement
Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide.
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.
This API action doesn't support filtering by tags.
getParametersByPath
in interface AWSSimpleSystemsManagement
public GetPatchBaselineResult getPatchBaseline(GetPatchBaselineRequest request)
AWSSimpleSystemsManagement
Retrieves information about a patch baseline.
getPatchBaseline
in interface AWSSimpleSystemsManagement
public GetPatchBaselineForPatchGroupResult getPatchBaselineForPatchGroup(GetPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagement
Retrieves the patch baseline that should be used for the specified patch group.
getPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
public GetServiceSettingResult getServiceSetting(GetServiceSettingRequest request)
AWSSimpleSystemsManagement
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to
change the value back to the original value defined by the AWS service team.
Query the current service setting for the account.
getServiceSetting
in interface AWSSimpleSystemsManagement
request
- The request body of the GetServiceSetting API action.public LabelParameterVersionResult labelParameterVersion(LabelParameterVersionRequest request)
AWSSimpleSystemsManagement
A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.
Parameter labels have the following requirements and restrictions.
A version of a parameter can have a maximum of 10 labels.
You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.
You can move a label from one version of a parameter to another.
You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.
You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.
A label can have a maximum of 100 characters.
Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).
Labels can't begin with a number, "aws," or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.
labelParameterVersion
in interface AWSSimpleSystemsManagement
public ListAssociationVersionsResult listAssociationVersions(ListAssociationVersionsRequest request)
AWSSimpleSystemsManagement
Retrieves all versions of an association for a specific association ID.
listAssociationVersions
in interface AWSSimpleSystemsManagement
public ListAssociationsResult listAssociations(ListAssociationsRequest request)
AWSSimpleSystemsManagement
Lists the associations for the specified Systems Manager document or instance.
listAssociations
in interface AWSSimpleSystemsManagement
public ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest request)
AWSSimpleSystemsManagement
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.
listCommandInvocations
in interface AWSSimpleSystemsManagement
public ListCommandsResult listCommands(ListCommandsRequest request)
AWSSimpleSystemsManagement
Lists the commands requested by users of the AWS account.
listCommands
in interface AWSSimpleSystemsManagement
public ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest request)
AWSSimpleSystemsManagement
For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.
listComplianceItems
in interface AWSSimpleSystemsManagement
public ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest request)
AWSSimpleSystemsManagement
Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.
listComplianceSummaries
in interface AWSSimpleSystemsManagement
public ListDocumentVersionsResult listDocumentVersions(ListDocumentVersionsRequest request)
AWSSimpleSystemsManagement
List all versions for a document.
listDocumentVersions
in interface AWSSimpleSystemsManagement
public ListDocumentsResult listDocuments(ListDocumentsRequest request)
AWSSimpleSystemsManagement
Describes one or more of your Systems Manager documents.
listDocuments
in interface AWSSimpleSystemsManagement
public ListDocumentsResult listDocuments()
AWSSimpleSystemsManagement
listDocuments
in interface AWSSimpleSystemsManagement
AWSSimpleSystemsManagement.listDocuments(ListDocumentsRequest)
public ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest request)
AWSSimpleSystemsManagement
A list of inventory items returned by the request.
listInventoryEntries
in interface AWSSimpleSystemsManagement
public ListResourceComplianceSummariesResult listResourceComplianceSummaries(ListResourceComplianceSummariesRequest request)
AWSSimpleSystemsManagement
Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.
listResourceComplianceSummaries
in interface AWSSimpleSystemsManagement
public ListResourceDataSyncResult listResourceDataSync(ListResourceDataSyncRequest request)
AWSSimpleSystemsManagement
Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.
The number of sync configurations might be too large to return using a single call to
ListResourceDataSync
. You can limit the number of sync configurations returned by using the
MaxResults
parameter. To determine whether there are more sync configurations to list, check the
value of NextToken
in the output. If there are more sync configurations to list, you can request
them by specifying the NextToken
returned in the call to the parameter of a subsequent call.
listResourceDataSync
in interface AWSSimpleSystemsManagement
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSSimpleSystemsManagement
Returns a list of the tags assigned to the specified resource.
listTagsForResource
in interface AWSSimpleSystemsManagement
public ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest request)
AWSSimpleSystemsManagement
Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.
modifyDocumentPermission
in interface AWSSimpleSystemsManagement
public PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest request)
AWSSimpleSystemsManagement
Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
ExecutionType: Specify patch, association, or Custom:string
.
ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved
for patches, or Failed
for associations.
Severity: A patch severity. For example, critical
.
DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.
DocumentVersion: An SSM document version number. For example, 4.
Classification: A patch classification. For example, security updates
.
PatchBaselineId: A patch baseline ID.
PatchSeverity: A patch severity. For example, Critical
.
PatchState: A patch state. For example, InstancesWithFailedPatches
.
PatchGroup: The name of a patch group.
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'
putComplianceItems
in interface AWSSimpleSystemsManagement
public PutInventoryResult putInventory(PutInventoryRequest request)
AWSSimpleSystemsManagement
Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.
putInventory
in interface AWSSimpleSystemsManagement
public PutParameterResult putParameter(PutParameterRequest request)
AWSSimpleSystemsManagement
Add a parameter to the system.
putParameter
in interface AWSSimpleSystemsManagement
public RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest request)
AWSSimpleSystemsManagement
Defines the default patch baseline for the relevant operating system.
To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID
value. For example, for CentOS, specify
arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed
instead of
pb-0574b43a65ea646ed
.
registerDefaultPatchBaseline
in interface AWSSimpleSystemsManagement
public RegisterPatchBaselineForPatchGroupResult registerPatchBaselineForPatchGroup(RegisterPatchBaselineForPatchGroupRequest request)
AWSSimpleSystemsManagement
Registers a patch baseline for a patch group.
registerPatchBaselineForPatchGroup
in interface AWSSimpleSystemsManagement
public RegisterTargetWithMaintenanceWindowResult registerTargetWithMaintenanceWindow(RegisterTargetWithMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Registers a target with a maintenance window.
registerTargetWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
public RegisterTaskWithMaintenanceWindowResult registerTaskWithMaintenanceWindow(RegisterTaskWithMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Adds a new task to a maintenance window.
registerTaskWithMaintenanceWindow
in interface AWSSimpleSystemsManagement
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AWSSimpleSystemsManagement
Removes tag keys from the specified resource.
removeTagsFromResource
in interface AWSSimpleSystemsManagement
public ResetServiceSettingResult resetServiceSetting(ResetServiceSettingRequest request)
AWSSimpleSystemsManagement
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to
change the default setting.
Reset the service setting for the account to the default value as provisioned by the AWS service team.
resetServiceSetting
in interface AWSSimpleSystemsManagement
request
- The request body of the ResetServiceSetting API action.public ResumeSessionResult resumeSession(ResumeSessionRequest request)
AWSSimpleSystemsManagement
Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.
This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.
resumeSession
in interface AWSSimpleSystemsManagement
public SendAutomationSignalResult sendAutomationSignal(SendAutomationSignalRequest request)
AWSSimpleSystemsManagement
Sends a signal to an Automation execution to change the current behavior or status of the execution.
sendAutomationSignal
in interface AWSSimpleSystemsManagement
public SendCommandResult sendCommand(SendCommandRequest request)
AWSSimpleSystemsManagement
Runs commands on one or more managed instances.
sendCommand
in interface AWSSimpleSystemsManagement
public StartAssociationsOnceResult startAssociationsOnce(StartAssociationsOnceRequest request)
AWSSimpleSystemsManagement
Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.
startAssociationsOnce
in interface AWSSimpleSystemsManagement
public StartAutomationExecutionResult startAutomationExecution(StartAutomationExecutionRequest request)
AWSSimpleSystemsManagement
Initiates execution of an Automation document.
startAutomationExecution
in interface AWSSimpleSystemsManagement
public StartSessionResult startSession(StartSessionRequest request)
AWSSimpleSystemsManagement
Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.
AWS CLI usage: start-session
is an interactive command that requires the Session Manager plugin to
be installed on the client machine making the call. For information, see
Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.
startSession
in interface AWSSimpleSystemsManagement
public StopAutomationExecutionResult stopAutomationExecution(StopAutomationExecutionRequest request)
AWSSimpleSystemsManagement
Stop an Automation that is currently running.
stopAutomationExecution
in interface AWSSimpleSystemsManagement
public TerminateSessionResult terminateSession(TerminateSessionRequest request)
AWSSimpleSystemsManagement
Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.
terminateSession
in interface AWSSimpleSystemsManagement
public UpdateAssociationResult updateAssociation(UpdateAssociationRequest request)
AWSSimpleSystemsManagement
Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.
When you update an association, the association immediately runs against the specified targets.
updateAssociation
in interface AWSSimpleSystemsManagement
public UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest request)
AWSSimpleSystemsManagement
Updates the status of the Systems Manager document associated with the specified instance.
updateAssociationStatus
in interface AWSSimpleSystemsManagement
public UpdateDocumentResult updateDocument(UpdateDocumentRequest request)
AWSSimpleSystemsManagement
Updates one or more values for an SSM document.
updateDocument
in interface AWSSimpleSystemsManagement
public UpdateDocumentDefaultVersionResult updateDocumentDefaultVersion(UpdateDocumentDefaultVersionRequest request)
AWSSimpleSystemsManagement
Set the default version of a document.
updateDocumentDefaultVersion
in interface AWSSimpleSystemsManagement
public UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)
AWSSimpleSystemsManagement
Updates an existing maintenance window. Only specified parameters are modified.
updateMaintenanceWindow
in interface AWSSimpleSystemsManagement
public UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest request)
AWSSimpleSystemsManagement
Modifies the target of an existing maintenance window. You can change the following:
Name
Description
Owner
IDs for an ID target
Tags for a Tag target
From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.
If a parameter is null, then the corresponding field is not modified.
updateMaintenanceWindowTarget
in interface AWSSimpleSystemsManagement
public UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest request)
AWSSimpleSystemsManagement
Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:
TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.
ServiceRoleArn
TaskInvocationParameters
Priority
MaxConcurrency
MaxErrors
If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.
updateMaintenanceWindowTask
in interface AWSSimpleSystemsManagement
public UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest request)
AWSSimpleSystemsManagement
Assigns or changes an Amazon Identity and Access Management (IAM) role for the managed instance.
updateManagedInstanceRole
in interface AWSSimpleSystemsManagement
public UpdateOpsItemResult updateOpsItem(UpdateOpsItemRequest request)
AWSSimpleSystemsManagement
Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.
Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
updateOpsItem
in interface AWSSimpleSystemsManagement
public UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest request)
AWSSimpleSystemsManagement
Modifies an existing patch baseline. Fields not specified in the request are left unchanged.
For information about valid key and value pairs in PatchFilters
for each supported operating system
type, see PatchFilter.
updatePatchBaseline
in interface AWSSimpleSystemsManagement
public UpdateServiceSettingResult updateServiceSetting(UpdateServiceSettingRequest request)
AWSSimpleSystemsManagement
ServiceSetting
is an account-level setting for an AWS service. This setting defines how a user
interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the
account based on feature or service usage, then the AWS service team might create a default setting of "false".
This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for
a paid feature.
Services map a SettingId
object to a setting value. AWS services teams define the default value for
a SettingId
. You can't create a new SettingId
, but you can overwrite the default value
if you have the ssm:UpdateServiceSetting
permission for the setting. Use the
GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change
the value back to the original value defined by the AWS service team.
Update the service setting for the account.
updateServiceSetting
in interface AWSSimpleSystemsManagement
request
- The request body of the UpdateServiceSetting API action.public void shutdown()
AWSSimpleSystemsManagement
shutdown
in interface AWSSimpleSystemsManagement
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSSimpleSystemsManagement
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSSimpleSystemsManagement
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.