Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.simplesystemsmanagement;
 
Interface for accessing AWSSimpleSystemsManagement.

AWS Simple Systems Management enables you to configure and manage your EC2 instances. You can create a configuration document and then associate it with one or more running instances.

You can use a configuration document to automate the following tasks for your Windows instances:

  • Install, repair, or uninstall software using an MSI package

  • Run PowerShell scripts

  • Join an AWS Directory

  • Configure CloudWatch Logs to monitor applications and systems

Note that configuration documents are not supported on Linux instances.

 
 public interface AWSSimpleSystemsManagement {

    
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 com.amazonaws.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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

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.
Throws:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
 
     public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the com.amazonaws.ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

    public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

Deletes the specified configuration document.

You must use DeleteAssociation to disassociate all instances that are associated with the configuration document before you can delete it.

Parameters:
deleteDocumentRequest Container for the necessary parameters to execute the DeleteDocument service method on AWSSimpleSystemsManagement.
Returns:
The response from the DeleteDocument service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.AssociatedInstancesException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public DeleteDocumentResult deleteDocument(DeleteDocumentRequest deleteDocumentRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Describes the associations for the specified configuration document or instance.

Parameters:
describeAssociationRequest Container for the necessary parameters to execute the DescribeAssociation service method on AWSSimpleSystemsManagement.
Returns:
The response from the DescribeAssociation service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidInstanceIdException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.services.simplesystemsmanagement.model.AssociationDoesNotExistException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public DescribeAssociationResult describeAssociation(DescribeAssociationRequest describeAssociationRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Associates the specified configuration document with the specified instance.

When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.

If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.

Parameters:
createAssociationRequest Container for the necessary parameters to execute the CreateAssociation service method on AWSSimpleSystemsManagement.
Returns:
The response from the CreateAssociation service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.AssociationLimitExceededException
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidInstanceIdException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.services.simplesystemsmanagement.model.AssociationAlreadyExistsException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public CreateAssociationResult createAssociation(CreateAssociationRequest createAssociationRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Associates the specified configuration documents with the specified instances.

When you associate a configuration document with an instance, the configuration agent on the instance processes the configuration document and configures the instance as specified.

If you associate a configuration document with an instance that already has an associated configuration document, we replace the current configuration document with the new configuration document.

Parameters:
createAssociationBatchRequest Container for the necessary parameters to execute the CreateAssociationBatch service method on AWSSimpleSystemsManagement.
Returns:
The response from the CreateAssociationBatch service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.DuplicateInstanceIdException
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.AssociationLimitExceededException
com.amazonaws.services.simplesystemsmanagement.model.InvalidInstanceIdException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Describes the specified configuration document.

Parameters:
describeDocumentRequest Container for the necessary parameters to execute the DescribeDocument service method on AWSSimpleSystemsManagement.
Returns:
The response from the DescribeDocument service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public DescribeDocumentResult describeDocument(DescribeDocumentRequest describeDocumentRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Updates the status of the configuration document associated with the specified instance.

Parameters:
updateAssociationStatusRequest Container for the necessary parameters to execute the UpdateAssociationStatus service method on AWSSimpleSystemsManagement.
Returns:
The response from the UpdateAssociationStatus service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidInstanceIdException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.services.simplesystemsmanagement.model.StatusUnchangedException
com.amazonaws.services.simplesystemsmanagement.model.TooManyUpdatesException
com.amazonaws.services.simplesystemsmanagement.model.AssociationDoesNotExistException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Lists the associations for the specified configuration document or instance.

Parameters:
listAssociationsRequest Container for the necessary parameters to execute the ListAssociations service method on AWSSimpleSystemsManagement.
Returns:
The response from the ListAssociations service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidNextTokenException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public ListAssociationsResult listAssociations(ListAssociationsRequest listAssociationsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more of your configuration documents.

Parameters:
listDocumentsRequest Container for the necessary parameters to execute the ListDocuments service method on AWSSimpleSystemsManagement.
Returns:
The response from the ListDocuments service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidNextTokenException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public ListDocumentsResult listDocuments(ListDocumentsRequest listDocumentsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Disassociates the specified configuration document from the specified instance.

When you disassociate a configuration document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a configuration document, you must create a new configuration document with the desired configuration and associate it with the instance.

Parameters:
deleteAssociationRequest Container for the necessary parameters to execute the DeleteAssociation service method on AWSSimpleSystemsManagement.
Returns:
The response from the DeleteAssociation service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidInstanceIdException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.services.simplesystemsmanagement.model.TooManyUpdatesException
com.amazonaws.services.simplesystemsmanagement.model.AssociationDoesNotExistException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public DeleteAssociationResult deleteAssociation(DeleteAssociationRequest deleteAssociationRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Creates a configuration document.

After you create a configuration document, you can use CreateAssociation to associate it with one or more running instances.

Parameters:
createDocumentRequest Container for the necessary parameters to execute the CreateDocument service method on AWSSimpleSystemsManagement.
Returns:
The response from the CreateDocument service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.DocumentAlreadyExistsException
com.amazonaws.services.simplesystemsmanagement.model.MaxDocumentSizeExceededException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentContentException
com.amazonaws.services.simplesystemsmanagement.model.DocumentLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public CreateDocumentResult createDocument(CreateDocumentRequest createDocumentRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Gets the contents of the specified configuration document.

Parameters:
getDocumentRequest Container for the necessary parameters to execute the GetDocument service method on AWSSimpleSystemsManagement.
Returns:
The response from the GetDocument service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidDocumentException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
    public GetDocumentResult getDocument(GetDocumentRequest getDocumentRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more of your configuration documents.

Returns:
The response from the ListDocuments service method, as returned by AWSSimpleSystemsManagement.
Throws:
com.amazonaws.services.simplesystemsmanagement.model.InternalServerErrorException
com.amazonaws.services.simplesystemsmanagement.model.InvalidNextTokenException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AWSSimpleSystemsManagement indicating either a problem with the data in the request, or a server side issue.
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.
    public void shutdown();
    
    
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.
}
        
New to GrepCode? Check out our FAQ X