JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.simplesystemsmanagement

Interface AWSSimpleSystemsManagement

    • Method Detail

      • setEndpoint

        @Deprecated
void setEndpoint(String endpoint)
        Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
        Overrides the default endpoint for this client ("https://ssm.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

        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.

        Parameters:
        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.

      • addTagsToResource

        AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

        Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed nodes that helps you track each node's owner and stack level. For example:

        • Key=Owner,Value=DbAdmin

        • Key=Owner,Value=SysAdmin

        • Key=Owner,Value=Dev

        • Key=Stack,Value=Production

        • Key=Stack,Value=Pre-Production

        • Key=Stack,Value=Test

        Most resources can have a maximum of 50 tags. Automations can have a maximum of 5 tags.

        We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to and are interpreted strictly as a string of characters.

        For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see Tag your Amazon EC2 resources in the Amazon EC2 User Guide.

        Parameters:
        addTagsToResourceRequest -
        Returns:
        Result of the AddTagsToResource operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • cancelCommand

        CancelCommandResult cancelCommand(CancelCommandRequest cancelCommandRequest)

        Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

        Parameters:
        cancelCommandRequest -
        Returns:
        Result of the CancelCommand operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidCommandIdException - The specified command ID isn't valid. Verify the ID and try again.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        DuplicateInstanceIdException - You can't specify a managed node ID in more than one association.
        See Also:
        AWS API Documentation

      • cancelMaintenanceWindowExecution

        CancelMaintenanceWindowExecutionResult cancelMaintenanceWindowExecution(CancelMaintenanceWindowExecutionRequest cancelMaintenanceWindowExecutionRequest)

        Stops a maintenance window execution that is already in progress and cancels any tasks in the window that haven't already starting running. Tasks already in progress will continue to completion.

        Parameters:
        cancelMaintenanceWindowExecutionRequest -
        Returns:
        Result of the CancelMaintenanceWindowExecution operation returned by the service.
        Throws:
        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.

        See Also:
        AWS API Documentation

      • createActivation

        CreateActivationResult createActivation(CreateActivationRequest createActivationRequest)

        Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid and multicloud environments in the Amazon Web Services Systems Manager User Guide.

        Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

        Parameters:
        createActivationRequest -
        Returns:
        Result of the CreateActivation operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • createAssociation

        CreateAssociationResult createAssociation(CreateAssociationRequest createAssociationRequest)

        A State Manager association defines the state that you want to maintain on your managed nodes. For example, an association can specify that anti-virus software must be installed and running on your managed nodes, or that certain ports must be closed. For static targets, the association specifies a schedule for when the configuration is reapplied. For dynamic targets, such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The association also specifies actions to take when applying the configuration. For example, an association for anti-virus software might run once a day. If the software isn't installed, then State Manager installs it. If the software is installed, but the service isn't running, then the association might instruct State Manager to start the service.

        Parameters:
        createAssociationRequest -
        Returns:
        Result of the CreateAssociation operation returned by the service.
        Throws:
        AssociationAlreadyExistsException - The specified association already exists.
        AssociationLimitExceededException - You can have at most 2,000 active associations.
        InternalServerErrorException - An error occurred on the server side.
        InvalidDocumentException - The specified SSM document doesn't exist.
        InvalidDocumentVersionException - The document version isn't valid or doesn't exist.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        UnsupportedPlatformTypeException - The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        InvalidOutputLocationException - The output location isn't valid or doesn't exist.
        InvalidParametersException - You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        InvalidTargetException - The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
        InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.
        InvalidTargetMapsException - TargetMap parameter isn't valid.
        InvalidTagException - The specified tag key or value isn't valid.
        See Also:
        AWS API Documentation

      • createAssociationBatch

        CreateAssociationBatchResult createAssociationBatch(CreateAssociationBatchRequest createAssociationBatchRequest)

        Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes or targets.

        When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the node as specified.

        If you associate a document with a managed node that already has an associated document, the system returns the AssociationAlreadyExists exception.

        Parameters:
        createAssociationBatchRequest -
        Returns:
        Result of the CreateAssociationBatch operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidDocumentException - The specified SSM document doesn't exist.
        InvalidDocumentVersionException - The document version isn't valid or doesn't exist.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidParametersException - You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        DuplicateInstanceIdException - You can't specify a managed node ID in more than one association.
        AssociationLimitExceededException - You can have at most 2,000 active associations.
        UnsupportedPlatformTypeException - The document doesn't support the platform type of the given managed node IDs. For example, you sent an document for a Windows managed node to a Linux node.
        InvalidOutputLocationException - The output location isn't valid or doesn't exist.
        InvalidTargetException - The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
        InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.
        InvalidTargetMapsException - TargetMap parameter isn't valid.
        See Also:
        AWS API Documentation

      • createMaintenanceWindow

        CreateMaintenanceWindowResult createMaintenanceWindow(CreateMaintenanceWindowRequest createMaintenanceWindowRequest)

        Creates a new maintenance window.

        The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

        Parameters:
        createMaintenanceWindowRequest -
        Returns:
        Result of the CreateMaintenanceWindow operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • createOpsItem

        CreateOpsItemResult createOpsItem(CreateOpsItemRequest createOpsItemRequest)

        Creates a new OpsItem. You must have permission in Identity and Access Management (IAM) to create a new OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Parameters:
        createOpsItemRequest -
        Returns:
        Result of the CreateOpsItem operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        OpsItemAlreadyExistsException - The OpsItem already exists.
        OpsItemLimitExceededException - The request caused OpsItems to exceed one or more quotas.
        OpsItemInvalidParameterException - A specified parameter argument isn't valid. Verify the available arguments and try again.
        OpsItemAccessDeniedException - You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
        See Also:
        AWS API Documentation

      • createResourceDataSync

        CreateResourceDataSyncResult createResourceDataSync(CreateResourceDataSyncRequest createResourceDataSyncRequest)

        A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource.

        You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Configuring resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide.

        You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.

        A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync.

        By default, data isn't encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy.

        Parameters:
        createResourceDataSyncRequest -
        Returns:
        Result of the CreateResourceDataSync operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • deleteActivation

        DeleteActivationResult deleteActivation(DeleteActivationRequest deleteActivationRequest)

        Deletes an activation. You aren't required to delete an activation. If you delete an activation, you can no longer use it to register additional managed nodes. Deleting an activation doesn't de-register managed nodes. You must manually de-register managed nodes.

        Parameters:
        deleteActivationRequest -
        Returns:
        Result of the DeleteActivation operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • deleteAssociation

        DeleteAssociationResult deleteAssociation(DeleteAssociationRequest deleteAssociationRequest)

        Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node. If you created the association by using the Targets parameter, then you must delete the association by using the association ID.

        When you disassociate a document from a managed node, it doesn't change the configuration of the node. To change the configuration state of a managed node after you disassociate a document, you must create a new document with the desired configuration and associate it with the node.

        Parameters:
        deleteAssociationRequest -
        Returns:
        Result of the DeleteAssociation operation returned by the service.
        Throws:
        AssociationDoesNotExistException - The specified association doesn't exist.
        InternalServerErrorException - An error occurred on the server side.
        InvalidDocumentException - The specified SSM document doesn't exist.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.
        See Also:
        AWS API Documentation

      • deleteOpsItem

        DeleteOpsItemResult deleteOpsItem(DeleteOpsItemRequest deleteOpsItemRequest)

        Delete an OpsItem. You must have permission in Identity and Access Management (IAM) to delete an OpsItem.

        Note the following important information about this operation.

        • Deleting an OpsItem is irreversible. You can't restore a deleted OpsItem.

        • This operation uses an eventual consistency model, which means the system can take a few minutes to complete this operation. If you delete an OpsItem and immediately call, for example, GetOpsItem, the deleted OpsItem might still appear in the response.

        • This operation is idempotent. The system doesn't throw an exception if you repeatedly call this operation for the same OpsItem. If the first call is successful, all additional calls return the same successful response as the first call.

        • This operation doesn't support cross-account calls. A delegated administrator or management account can't delete OpsItems in other accounts, even if OpsCenter has been set up for cross-account administration. For more information about cross-account administration, see Setting up OpsCenter to centrally manage OpsItems across accounts in the Systems Manager User Guide.

        Parameters:
        deleteOpsItemRequest -
        Returns:
        Result of the DeleteOpsItem operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        OpsItemInvalidParameterException - A specified parameter argument isn't valid. Verify the available arguments and try again.
        See Also:
        AWS API Documentation

      • deleteResourcePolicy

        DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

        Deletes a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

        • OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

        • Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM). For more information about cross-account sharing of parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.

        Parameters:
        deleteResourcePolicyRequest -
        Returns:
        Result of the DeleteResourcePolicy operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        ResourcePolicyInvalidParameterException - One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
        ResourcePolicyConflictException - The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.
        ResourceNotFoundException - The specified parameter to be shared could not be found.
        MalformedResourcePolicyDocumentException - The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.
        ResourcePolicyNotFoundException - No policies with the specified policy ID and hash could be found.
        See Also:
        AWS API Documentation

      • deregisterManagedInstance

        DeregisterManagedInstanceResult deregisterManagedInstance(DeregisterManagedInstanceRequest deregisterManagedInstanceRequest)

        Removes the server or virtual machine from the list of registered servers. You can reregister the node again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.

        Parameters:
        deregisterManagedInstanceRequest -
        Returns:
        Result of the DeregisterManagedInstance operation returned by the service.
        Throws:
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • describeActivations

        DescribeActivationsResult describeActivations(DescribeActivationsRequest describeActivationsRequest)

        Describes details about the activation, such as the date and time the activation was created, its expiration date, the Identity and Access Management (IAM) role assigned to the managed nodes in the activation, and the number of nodes registered by using this activation.

        Parameters:
        describeActivationsRequest -
        Returns:
        Result of the DescribeActivations operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • describeAssociation

        DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest)

        Describes the association for the specified target or managed node. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID.

        Parameters:
        describeAssociationRequest -
        Returns:
        Result of the DescribeAssociation operation returned by the service.
        Throws:
        AssociationDoesNotExistException - The specified association doesn't exist.
        InvalidAssociationVersionException - The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.
        InternalServerErrorException - An error occurred on the server side.
        InvalidDocumentException - The specified SSM document doesn't exist.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        See Also:
        AWS API Documentation

      • describeAvailablePatches

        DescribeAvailablePatchesResult describeAvailablePatches(DescribeAvailablePatchesRequest describeAvailablePatchesRequest)

        Lists all patches eligible to be included in a patch baseline.

        Currently, DescribeAvailablePatches supports only the Amazon Linux 1, Amazon Linux 2, and Windows Server operating systems.

        Parameters:
        describeAvailablePatchesRequest -
        Returns:
        Result of the DescribeAvailablePatches operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • describeEffectiveInstanceAssociations

        DescribeEffectiveInstanceAssociationsResult describeEffectiveInstanceAssociations(DescribeEffectiveInstanceAssociationsRequest describeEffectiveInstanceAssociationsRequest)

        All associations for the managed nodes.

        Parameters:
        describeEffectiveInstanceAssociationsRequest -
        Returns:
        Result of the DescribeEffectiveInstanceAssociations operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • describeInstanceAssociationsStatus

        DescribeInstanceAssociationsStatusResult describeInstanceAssociationsStatus(DescribeInstanceAssociationsStatusRequest describeInstanceAssociationsStatusRequest)

        The status of the associations for the managed nodes.

        Parameters:
        describeInstanceAssociationsStatusRequest -
        Returns:
        Result of the DescribeInstanceAssociationsStatus operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • describeInstanceInformation

        DescribeInstanceInformationResult describeInstanceInformation(DescribeInstanceInformationRequest describeInstanceInformationRequest)

        Provides information about one or more of your managed nodes, including the operating system platform, SSM Agent version, association status, and IP address. This operation does not return information for nodes that are either Stopped or Terminated.

        If you specify one or more node IDs, the operation returns information for those managed nodes. If you don't specify node IDs, it returns information for all your managed nodes. If you specify a node ID that isn't valid or a node that you don't own, you receive an error.

        The IamRole field returned for this API operation is the Identity and Access Management (IAM) role assigned to on-premises managed nodes. This operation does not return the IAM role for EC2 instances.

        Parameters:
        describeInstanceInformationRequest -
        Returns:
        Result of the DescribeInstanceInformation operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidNextTokenException - The specified token isn't valid.
        InvalidInstanceInformationFilterValueException - The specified filter value isn't valid.
        InvalidFilterKeyException - The specified key isn't valid.
        See Also:
        AWS API Documentation

      • describeInstancePatches

        DescribeInstancePatchesResult describeInstancePatches(DescribeInstancePatchesRequest describeInstancePatchesRequest)

        Retrieves information about the patches on the specified managed node and their state relative to the patch baseline being used for the node.

        Parameters:
        describeInstancePatchesRequest -
        Returns:
        Result of the DescribeInstancePatches operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidFilterException - The filter name isn't valid. Verify the you entered the correct name and try again.
        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • describeMaintenanceWindowExecutions

        DescribeMaintenanceWindowExecutionsResult describeMaintenanceWindowExecutions(DescribeMaintenanceWindowExecutionsRequest describeMaintenanceWindowExecutionsRequest)

        Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

        Parameters:
        describeMaintenanceWindowExecutionsRequest -
        Returns:
        Result of the DescribeMaintenanceWindowExecutions operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • describeMaintenanceWindowTasks

        DescribeMaintenanceWindowTasksResult describeMaintenanceWindowTasks(DescribeMaintenanceWindowTasksRequest describeMaintenanceWindowTasksRequest)

        Lists the tasks in a maintenance window.

        For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

        Parameters:
        describeMaintenanceWindowTasksRequest -
        Returns:
        Result of the DescribeMaintenanceWindowTasks operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • describeOpsItems

        DescribeOpsItemsResult describeOpsItems(DescribeOpsItemsRequest describeOpsItemsRequest)

        Query a set of OpsItems. You must have permission in Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Parameters:
        describeOpsItemsRequest -
        Returns:
        Result of the DescribeOpsItems operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • describeParameters

        DescribeParametersResult describeParameters(DescribeParametersRequest describeParametersRequest)

        Lists the parameters in your Amazon Web Services account or the parameters shared with you when you enable the Shared option.

        Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

        If you change the KMS key alias for the KMS key used to encrypt a parameter, then you must also update the key alias the parameter uses to reference KMS. Otherwise, DescribeParameters retrieves whatever the original key alias was referencing.

        Parameters:
        describeParametersRequest -
        Returns:
        Result of the DescribeParameters operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • describePatchProperties

        DescribePatchPropertiesResult describePatchProperties(DescribePatchPropertiesRequest describePatchPropertiesRequest)

        Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for operations such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

        The following section lists the properties that can be used in filters for each major operating system type:

        AMAZON_LINUX

        Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

        AMAZON_LINUX_2

        Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

        CENTOS

        Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

        DEBIAN

        Valid properties: PRODUCT | PRIORITY

        MACOS

        Valid properties: PRODUCT | CLASSIFICATION

        ORACLE_LINUX

        Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

        REDHAT_ENTERPRISE_LINUX

        Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

        SUSE

        Valid properties: PRODUCT | CLASSIFICATION | SEVERITY

        UBUNTU

        Valid properties: PRODUCT | PRIORITY

        WINDOWS

        Valid properties: PRODUCT | PRODUCT_FAMILY | CLASSIFICATION | MSRC_SEVERITY

        Parameters:
        describePatchPropertiesRequest -
        Returns:
        Result of the DescribePatchProperties operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • getCalendarState

        GetCalendarStateResult getCalendarState(GetCalendarStateRequest getCalendarStateRequest)

        Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

        If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

        For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

        Parameters:
        getCalendarStateRequest -
        Returns:
        Result of the GetCalendarState operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • getCommandInvocation

        GetCommandInvocationResult getCommandInvocation(GetCommandInvocationRequest getCommandInvocationRequest)

        Returns detailed information about command execution for an invocation or plugin.

        GetCommandInvocation only gives the execution status of a plugin in a document. To get the command execution status on a specific managed node, use ListCommandInvocations. To get the command execution status across managed nodes, use ListCommands.

        Parameters:
        getCommandInvocationRequest -
        Returns:
        Result of the GetCommandInvocation operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidCommandIdException - The specified command ID isn't valid. Verify the ID and try again.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidPluginNameException - The plugin name isn't valid.
        InvocationDoesNotExistException - The command ID and managed node ID you specified didn't match any invocations. Verify the command ID and the managed node ID and try again.
        See Also:
        AWS API Documentation

      • getConnectionStatus

        GetConnectionStatusResult getConnectionStatus(GetConnectionStatusRequest getConnectionStatusRequest)

        Retrieves the Session Manager connection status for a managed node to determine whether it is running and ready to receive Session Manager connections.

        Parameters:
        getConnectionStatusRequest -
        Returns:
        Result of the GetConnectionStatus operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • getDefaultPatchBaseline

        GetDefaultPatchBaselineResult getDefaultPatchBaseline(GetDefaultPatchBaselineRequest getDefaultPatchBaselineRequest)

        Retrieves the default patch baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

        If you don't specify an operating system value, the default patch baseline for Windows is returned.

        Parameters:
        getDefaultPatchBaselineRequest -
        Returns:
        Result of the GetDefaultPatchBaseline operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • getDeployablePatchSnapshotForInstance

        GetDeployablePatchSnapshotForInstanceResult getDeployablePatchSnapshotForInstance(GetDeployablePatchSnapshotForInstanceRequest getDeployablePatchSnapshotForInstanceRequest)

        Retrieves the current snapshot for the patch baseline the managed node uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document (SSM document).

        If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command. For example, run the command using the AWS-RunShellScript document or the AWS-RunPowerShellScript document.

        Parameters:
        getDeployablePatchSnapshotForInstanceRequest -
        Returns:
        Result of the GetDeployablePatchSnapshotForInstance operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        UnsupportedOperatingSystemException - The operating systems you specified isn't supported, or the operation isn't supported for the operating system.
        UnsupportedFeatureRequiredException - Patching for applications released by Microsoft is only available on EC2 instances and advanced instances. To patch applications released by Microsoft on on-premises servers and VMs, you must enable advanced instances. For more information, see Turning on the advanced-instances tier in the Amazon Web Services Systems Manager User Guide.
        See Also:
        AWS API Documentation

      • getMaintenanceWindowTask

        GetMaintenanceWindowTaskResult getMaintenanceWindowTask(GetMaintenanceWindowTaskRequest getMaintenanceWindowTaskRequest)

        Retrieves the details of a maintenance window task.

        For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

        To retrieve a list of tasks in a maintenance window, instead use the DescribeMaintenanceWindowTasks command.

        Parameters:
        getMaintenanceWindowTaskRequest -
        Returns:
        Result of the GetMaintenanceWindowTask operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • getOpsItem

        GetOpsItemResult getOpsItem(GetOpsItemRequest getOpsItemRequest)

        Get information about an OpsItem by using the ID. You must have permission in Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Parameters:
        getOpsItemRequest -
        Returns:
        Result of the GetOpsItem operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        OpsItemNotFoundException - The specified OpsItem ID doesn't exist. Verify the ID and try again.
        OpsItemAccessDeniedException - You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
        See Also:
        AWS API Documentation

      • getOpsSummary

        GetOpsSummaryResult getOpsSummary(GetOpsSummaryRequest getOpsSummaryRequest)

        View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

        Parameters:
        getOpsSummaryRequest -
        Returns:
        Result of the GetOpsSummary operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • getParametersByPath

        GetParametersByPathResult getParametersByPath(GetParametersByPathRequest getParametersByPathRequest)

        Retrieve information about one or more parameters in a specific hierarchy.

        Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

        Parameters:
        getParametersByPathRequest -
        Returns:
        Result of the GetParametersByPath operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • getServiceSetting

        GetServiceSettingResult getServiceSetting(GetServiceSettingRequest getServiceSettingRequest)

        ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of false. This means the user can't use this feature unless they change the setting to true and intentionally opt in for a paid feature.

        Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API operation to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

        Query the current service setting for the Amazon Web Services account.

        Parameters:
        getServiceSettingRequest - The request body of the GetServiceSetting API operation.
        Returns:
        Result of the GetServiceSetting operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • labelParameterVersion

        LabelParameterVersionResult labelParameterVersion(LabelParameterVersionRequest labelParameterVersionRequest)

        A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Amazon Web Services Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

        Parameter labels have the following requirements and restrictions.

        • A version of a parameter can have a maximum of 10 labels.

        • You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

        • You can move a label from one version of a parameter to another.

        • You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

        • If you no longer want to use a parameter label, then you can either delete it or move it to a different version of a parameter.

        • A label can have a maximum of 100 characters.

        • Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

        • Labels can't begin with a number, "aws" or "ssm" (not case sensitive). If a label fails to meet these requirements, then the label isn't associated with a parameter and the system displays it in the list of InvalidLabels.

        Parameters:
        labelParameterVersionRequest -
        Returns:
        Result of the LabelParameterVersion operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • listAssociations

        ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest)

        Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

        Parameters:
        listAssociationsRequest -
        Returns:
        Result of the ListAssociations operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • listCommandInvocations

        ListCommandInvocationsResult listCommandInvocations(ListCommandInvocationsRequest listCommandInvocationsRequest)

        An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node ID. ListCommandInvocations provide status about command execution.

        Parameters:
        listCommandInvocationsRequest -
        Returns:
        Result of the ListCommandInvocations operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidCommandIdException - The specified command ID isn't valid. Verify the ID and try again.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidFilterKeyException - The specified key isn't valid.
        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • listCommands

        ListCommandsResult listCommands(ListCommandsRequest listCommandsRequest)

        Lists the commands requested by users of the Amazon Web Services account.

        Parameters:
        listCommandsRequest -
        Returns:
        Result of the ListCommands operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidCommandIdException - The specified command ID isn't valid. Verify the ID and try again.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidFilterKeyException - The specified key isn't valid.
        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • listComplianceItems

        ListComplianceItemsResult listComplianceItems(ListComplianceItemsRequest listComplianceItemsRequest)

        For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

        Parameters:
        listComplianceItemsRequest -
        Returns:
        Result of the ListComplianceItems operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • listComplianceSummaries

        ListComplianceSummariesResult listComplianceSummaries(ListComplianceSummariesRequest listComplianceSummariesRequest)

        Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

        Parameters:
        listComplianceSummariesRequest -
        Returns:
        Result of the ListComplianceSummaries operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • listInventoryEntries

        ListInventoryEntriesResult listInventoryEntries(ListInventoryEntriesRequest listInventoryEntriesRequest)

        A list of inventory items returned by the request.

        Parameters:
        listInventoryEntriesRequest -
        Returns:
        Result of the ListInventoryEntries operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidTypeNameException - The parameter type name isn't valid.
        InvalidFilterException - The filter name isn't valid. Verify the you entered the correct name and try again.
        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • listResourceDataSync

        ListResourceDataSyncResult listResourceDataSync(ListResourceDataSyncRequest listResourceDataSyncRequest)

        Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

        The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

        Parameters:
        listResourceDataSyncRequest -
        Returns:
        Result of the ListResourceDataSync operation returned by the service.
        Throws:
        ResourceDataSyncInvalidConfigurationException - The specified sync configuration is invalid.
        InternalServerErrorException - An error occurred on the server side.
        InvalidNextTokenException - The specified token isn't valid.
        See Also:
        AWS API Documentation

      • modifyDocumentPermission

        ModifyDocumentPermissionResult modifyDocumentPermission(ModifyDocumentPermissionRequest modifyDocumentPermissionRequest)

        Shares a Amazon Web Services Systems Manager document (SSM document)publicly or privately. If you share a document privately, you must specify the Amazon Web Services user IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

        Parameters:
        modifyDocumentPermissionRequest -
        Returns:
        Result of the ModifyDocumentPermission operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidDocumentException - The specified SSM document doesn't exist.
        InvalidPermissionTypeException - The permission type isn't supported. Share is the only supported permission type.
        DocumentPermissionLimitException - The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.

        By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.

        If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.

        DocumentLimitExceededException - You can have at most 500 active SSM documents.
        See Also:
        AWS API Documentation

      • putComplianceItems

        PutComplianceItemsResult putComplianceItems(PutComplianceItemsRequest putComplianceItemsRequest)

        Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

        ComplianceType can be one of the following:

        • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

        • ExecutionType: Specify patch, association, or Custom:string.

        • ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.

        • Id: The patch, association, or custom compliance ID.

        • Title: A title.

        • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

        • Severity: A patch severity. For example, Critical.

        • DocumentName: An SSM document name. For example, AWS-RunPatchBaseline.

        • DocumentVersion: An SSM document version number. For example, 4.

        • Classification: A patch classification. For example, security updates.

        • PatchBaselineId: A patch baseline ID.

        • PatchSeverity: A patch severity. For example, Critical.

        • PatchState: A patch state. For example, InstancesWithFailedPatches.

        • PatchGroup: The name of a patch group.

        • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

        Parameters:
        putComplianceItemsRequest -
        Returns:
        Result of the PutComplianceItems operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • putParameter

        PutParameterResult putParameter(PutParameterRequest putParameterRequest)

        Add a parameter to the system.

        Parameters:
        putParameterRequest -
        Returns:
        Result of the PutParameter operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • putResourcePolicy

        PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

        Creates or updates a Systems Manager resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your Systems Manager resources. The following resources support Systems Manager resource policies.

        • OpsItemGroup - The resource policy for OpsItemGroup enables Amazon Web Services accounts to view and interact with OpsCenter operational work items (OpsItems).

        • Parameter - The resource policy is used to share a parameter with other accounts using Resource Access Manager (RAM).

          To share a parameter, it must be in the advanced parameter tier. For information about parameter tiers, see Managing parameter tiers. For information about changing an existing standard parameter to an advanced parameter, see Changing a standard parameter to an advanced parameter.

          To share a SecureString parameter, it must be encrypted with a customer managed key, and you must share the key separately through Key Management Service. Amazon Web Services managed keys cannot be shared. Parameters encrypted with the default Amazon Web Services managed key can be updated to use a customer managed key instead. For KMS key definitions, see KMS concepts in the Key Management Service Developer Guide.

          While you can share a parameter using the Systems Manager PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. This is because using PutResourcePolicy requires the extra step of promoting the parameter to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. Otherwise, the parameter won't be returned by the Systems Manager DescribeParameters API operation using the --shared option.

          For more information, see Sharing a parameter in the Amazon Web Services Systems Manager User Guide

        Parameters:
        putResourcePolicyRequest -
        Returns:
        Result of the PutResourcePolicy operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        ResourcePolicyInvalidParameterException - One or more parameters specified for the call aren't valid. Verify the parameters and their values and try again.
        ResourcePolicyLimitExceededException - The PutResourcePolicy API action enforces two limits. A policy can't be greater than 1024 bytes in size. And only one policy can be attached to OpsItemGroup. Verify these limits and try again.
        ResourcePolicyConflictException - The hash provided in the call doesn't match the stored hash. This exception is thrown when trying to update an obsolete policy version or when multiple requests to update a policy are sent.
        ResourceNotFoundException - The specified parameter to be shared could not be found.
        MalformedResourcePolicyDocumentException - The specified policy document is malformed or invalid, or excessive PutResourcePolicy or DeleteResourcePolicy calls have been made.
        ResourcePolicyNotFoundException - No policies with the specified policy ID and hash could be found.
        See Also:
        AWS API Documentation

      • registerDefaultPatchBaseline

        RegisterDefaultPatchBaselineResult registerDefaultPatchBaseline(RegisterDefaultPatchBaselineRequest registerDefaultPatchBaselineRequest)

        Defines the default patch baseline for the relevant operating system.

        To reset the Amazon Web Services-predefined patch baseline as the default, specify the full patch baseline Amazon Resource Name (ARN) as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

        Parameters:
        registerDefaultPatchBaselineRequest -
        Returns:
        Result of the RegisterDefaultPatchBaseline operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • resetServiceSetting

        ResetServiceSettingResult resetServiceSetting(ResetServiceSettingRequest resetServiceSettingRequest)

        ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

        Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Use the UpdateServiceSetting API operation to change the default setting.

        Reset the service setting for the account to the default value as provisioned by the Amazon Web Services service team.

        Parameters:
        resetServiceSettingRequest - The request body of the ResetServiceSetting API operation.
        Returns:
        Result of the ResetServiceSetting operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • resumeSession

        ResumeSessionResult resumeSession(ResumeSessionRequest resumeSessionRequest)

        Reconnects a session to a managed node after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

        This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It isn't intended for any other use.

        Parameters:
        resumeSessionRequest -
        Returns:
        Result of the ResumeSession operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • startSession

        StartSessionResult startSession(StartSessionRequest startSessionRequest)

        Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

        Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

        Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

        Parameters:
        startSessionRequest -
        Returns:
        Result of the StartSession operation returned by the service.
        Throws:
        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 Region
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • terminateSession

        TerminateSessionResult terminateSession(TerminateSessionRequest terminateSessionRequest)

        Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the managed node. A terminated session can't be resumed.

        Parameters:
        terminateSessionRequest -
        Returns:
        Result of the TerminateSession operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • updateAssociation

        UpdateAssociationResult updateAssociation(UpdateAssociationRequest updateAssociationRequest)

        Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you call UpdateAssociation, the system removes all optional parameters from the request and overwrites the association with null values for those parameters. This is by design. You must specify all optional parameters in the call, even if you are not changing the parameters. This includes the Name parameter. Before calling this API action, we recommend that you call the DescribeAssociation API operation and make a note of all optional parameters required for your UpdateAssociation call.

        In order to call this API operation, a user, group, or role must be granted permission to call the DescribeAssociation API operation. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

        When you update an association, the association immediately runs against the specified targets. You can add the ApplyOnlyAtCronInterval parameter to run the association during the next schedule run.

        Parameters:
        updateAssociationRequest -
        Returns:
        Result of the UpdateAssociation operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidScheduleException - The schedule is invalid. Verify your cron or rate expression and try again.
        InvalidParametersException - You must specify values for all required parameters in the Amazon Web Services Systems Manager document (SSM document). You can only supply values to parameters defined in the SSM document.
        InvalidOutputLocationException - The output location isn't valid or doesn't exist.
        InvalidDocumentVersionException - The document version isn't valid or doesn't exist.
        AssociationDoesNotExistException - The specified association doesn't exist.
        InvalidUpdateException - The update isn't valid.
        TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.
        InvalidDocumentException - The specified SSM document doesn't exist.
        InvalidTargetException - The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might not have permission to perform the operation.
        InvalidAssociationVersionException - The version you specified isn't valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.
        AssociationVersionLimitExceededException - You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.
        InvalidTargetMapsException - TargetMap parameter isn't valid.
        See Also:
        AWS API Documentation

      • updateAssociationStatus

        UpdateAssociationStatusResult updateAssociationStatus(UpdateAssociationStatusRequest updateAssociationStatusRequest)

        Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified managed node.

        UpdateAssociationStatus is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to report status updates about your associations and is only used for associations created with the InstanceId legacy parameter.

        Parameters:
        updateAssociationStatusRequest -
        Returns:
        Result of the UpdateAssociationStatus operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InvalidDocumentException - The specified SSM document doesn't exist.
        AssociationDoesNotExistException - The specified association doesn't exist.
        StatusUnchangedException - The updated status is the same as the current status.
        TooManyUpdatesException - There are concurrent updates for a resource that supports one update at a time.
        See Also:
        AWS API Documentation

      • updateMaintenanceWindow

        UpdateMaintenanceWindowResult updateMaintenanceWindow(UpdateMaintenanceWindowRequest updateMaintenanceWindowRequest)

        Updates an existing maintenance window. Only specified parameters are modified.

        The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

        Parameters:
        updateMaintenanceWindowRequest -
        Returns:
        Result of the UpdateMaintenanceWindow operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • updateMaintenanceWindowTarget

        UpdateMaintenanceWindowTargetResult updateMaintenanceWindowTarget(UpdateMaintenanceWindowTargetRequest updateMaintenanceWindowTargetRequest)

        Modifies the target of an existing maintenance window. You can change the following:

        • Name

        • Description

        • Owner

        • IDs for an ID target

        • Tags for a Tag target

        • From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

        If a parameter is null, then the corresponding field isn't modified.

        Parameters:
        updateMaintenanceWindowTargetRequest -
        Returns:
        Result of the UpdateMaintenanceWindowTarget operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • updateMaintenanceWindowTask

        UpdateMaintenanceWindowTaskResult updateMaintenanceWindowTask(UpdateMaintenanceWindowTaskRequest updateMaintenanceWindowTaskRequest)

        Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:

        • TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

        • ServiceRoleArn

        • TaskInvocationParameters

        • Priority

        • MaxConcurrency

        • MaxErrors

        One or more targets must be specified for maintenance window Run Command-type tasks. Depending on the task, targets are optional for other maintenance window task types (Automation, Lambda, and Step Functions). For more information about running tasks that don't specify targets, see Registering maintenance window tasks without targets in the Amazon Web Services Systems Manager User Guide.

        If the value for a parameter in UpdateMaintenanceWindowTask is null, then the corresponding field isn't modified. If you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow operation are required for this request. Optional fields that aren't specified are set to null.

        When you update a maintenance window task that has options specified in TaskInvocationParameters, you must provide again all the TaskInvocationParameters values that you want to retain. The values you don't specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment, NotificationConfig, and OutputS3BucketName. If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.

        Parameters:
        updateMaintenanceWindowTaskRequest -
        Returns:
        Result of the UpdateMaintenanceWindowTask operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • updateManagedInstanceRole

        UpdateManagedInstanceRoleResult updateManagedInstanceRole(UpdateManagedInstanceRoleRequest updateManagedInstanceRoleRequest)

        Changes the Identity and Access Management (IAM) role that is assigned to the on-premises server, edge device, or virtual machines (VM). IAM roles are first assigned to these hybrid nodes during the activation process. For more information, see CreateActivation.

        Parameters:
        updateManagedInstanceRoleRequest -
        Returns:
        Result of the UpdateManagedInstanceRole operation returned by the service.
        Throws:
        InvalidInstanceIdException - The following problems can cause this exception:

        • You don't have permission to access the managed node.

        • Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.

        • SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.

        • The managed node isn't in a valid state. Valid states are: Running, Pending, Stopped, and Stopping. Invalid states are: Shutting-down and Terminated.

        InternalServerErrorException - An error occurred on the server side.
        See Also:
        AWS API Documentation

      • updateOpsItem

        UpdateOpsItemResult updateOpsItem(UpdateOpsItemRequest updateOpsItemRequest)

        Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

        Parameters:
        updateOpsItemRequest -
        Returns:
        Result of the UpdateOpsItem operation returned by the service.
        Throws:
        InternalServerErrorException - An error occurred on the server side.
        OpsItemNotFoundException - The specified OpsItem ID doesn't exist. Verify the ID and try again.
        OpsItemAlreadyExistsException - The OpsItem already exists.
        OpsItemLimitExceededException - The request caused OpsItems to exceed one or more quotas.
        OpsItemInvalidParameterException - A specified parameter argument isn't valid. Verify the available arguments and try again.
        OpsItemAccessDeniedException - You don't have permission to view OpsItems in the specified account. Verify that your account is configured either as a Systems Manager delegated administrator or that you are logged into the Organizations management account.
        OpsItemConflictException - The specified OpsItem is in the process of being deleted.
        See Also:
        AWS API Documentation

      • updatePatchBaseline

        UpdatePatchBaselineResult updatePatchBaseline(UpdatePatchBaselineRequest updatePatchBaselineRequest)

        Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

        For information about valid key-value pairs in PatchFilters for each supported operating system type, see PatchFilter.

        Parameters:
        updatePatchBaselineRequest -
        Returns:
        Result of the UpdatePatchBaseline operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • updateResourceDataSync

        UpdateResourceDataSyncResult updateResourceDataSync(UpdateResourceDataSyncRequest updateResourceDataSyncRequest)

        Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.

        This API operation only supports a resource data sync that was created with a SyncFromSource SyncType.

        Parameters:
        updateResourceDataSyncRequest -
        Returns:
        Result of the UpdateResourceDataSync operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • updateServiceSetting

        UpdateServiceSettingResult updateServiceSetting(UpdateServiceSettingRequest updateServiceSettingRequest)

        ServiceSetting is an account-level setting for an Amazon Web Services service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an Amazon Web Services service charges money to the account based on feature or service usage, then the Amazon Web Services service team might create a default setting of "false". This means the user can't use this feature unless they change the setting to "true" and intentionally opt in for a paid feature.

        Services map a SettingId object to a setting value. Amazon Web Services services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API operation to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the Amazon Web Services service team.

        Update the service setting for the account.

        Parameters:
        updateServiceSettingRequest - The request body of the UpdateServiceSetting API operation.
        Returns:
        Result of the UpdateServiceSetting operation returned by the service.
        Throws:
        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.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

      • getCachedResponseMetadata

        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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        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.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /