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.config;
 
Interface for accessing AmazonConfig. AWS Config

AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see Supported AWS Resources .

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config

This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.

The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process .

For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config? in the AWS Config Developer Guide .

 
 public interface AmazonConfig {

    
Overrides the default endpoint for this client ("https://config.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: "config.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://config.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: "config.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://config.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;
    
    

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

NOTE:Currently, you can specify only one delivery channel per account.

Parameters:
describeDeliveryChannelStatusRequest Container for the necessary parameters to execute the DescribeDeliveryChannelStatus service method on AmazonConfig.
Returns:
The response from the DescribeDeliveryChannelStatus service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchDeliveryChannelException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.

NOTE: Currently, you can specify only one configuration recorder per account.

Parameters:
describeConfigurationRecordersRequest Container for the necessary parameters to execute the DescribeConfigurationRecorders service method on AmazonConfig.
Returns:
The response from the DescribeConfigurationRecorders service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchConfigurationRecorderException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Starts recording configurations of all the resources associated with the account.

You must have created at least one delivery channel to successfully start the configuration recorder.

Parameters:
startConfigurationRecorderRequest Container for the necessary parameters to execute the StartConfigurationRecorder service method on AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchConfigurationRecorderException
com.amazonaws.services.config.model.NoAvailableDeliveryChannelException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
    public void startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

NOTE: Currently, you can specify only one delivery channel per account.

Parameters:
putDeliveryChannelRequest Container for the necessary parameters to execute the PutDeliveryChannel service method on AmazonConfig.
Throws:
com.amazonaws.services.config.model.InvalidDeliveryChannelNameException
com.amazonaws.services.config.model.InvalidS3KeyPrefixException
com.amazonaws.services.config.model.NoAvailableConfigurationRecorderException
com.amazonaws.services.config.model.NoSuchBucketException
com.amazonaws.services.config.model.InvalidSNSTopicARNException
com.amazonaws.services.config.model.InsufficientDeliveryPolicyException
com.amazonaws.services.config.model.MaxNumberOfDeliveryChannelsExceededException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
    public void putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified delivery channel.

The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action.

Parameters:
deleteDeliveryChannelRequest Container for the necessary parameters to execute the DeleteDeliveryChannel service method on AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchDeliveryChannelException
com.amazonaws.services.config.model.LastDeliveryChannelDeleteFailedException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
    public void deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Stops recording configurations of all the resources associated with the account.

Parameters:
stopConfigurationRecorderRequest Container for the necessary parameters to execute the StopConfigurationRecorder service method on AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchConfigurationRecorderException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
    public void stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.

  • Notification of starting the delivery.
  • Notification of delivery completed, if the delivery was successfully completed.
  • Notification of delivery failure, if the delivery failed to complete.

Parameters:
deliverConfigSnapshotRequest Container for the necessary parameters to execute the DeliverConfigSnapshot service method on AmazonConfig.
Returns:
The response from the DeliverConfigSnapshot service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchDeliveryChannelException
com.amazonaws.services.config.model.NoAvailableConfigurationRecorderException
com.amazonaws.services.config.model.NoRunningConfigurationRecorderException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Creates a new configuration recorder to record the resource configurations.

You can use this action to change the role ( roleARN ) of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

NOTE: Currently, you can specify only one configuration recorder per account.

Parameters:
putConfigurationRecorderRequest Container for the necessary parameters to execute the PutConfigurationRecorder service method on AmazonConfig.
Throws:
com.amazonaws.services.config.model.InvalidRoleException
com.amazonaws.services.config.model.InvalidConfigurationRecorderNameException
com.amazonaws.services.config.model.MaxNumberOfConfigurationRecordersExceededException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
    public void putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. You can specify a limit on the number of results returned on the page. If a limit is specified, a nextToken is returned as part of the result that you can use to continue this request.

NOTE: Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken .

Parameters:
getResourceConfigHistoryRequest Container for the necessary parameters to execute the GetResourceConfigHistory service method on AmazonConfig.
Returns:
The response from the GetResourceConfigHistory service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.InvalidNextTokenException
com.amazonaws.services.config.model.NoAvailableConfigurationRecorderException
com.amazonaws.services.config.model.ValidationException
com.amazonaws.services.config.model.ResourceNotDiscoveredException
com.amazonaws.services.config.model.InvalidTimeRangeException
com.amazonaws.services.config.model.InvalidLimitException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

NOTE: Currently, you can specify only one delivery channel per account.

Parameters:
describeDeliveryChannelsRequest Container for the necessary parameters to execute the DescribeDeliveryChannels service method on AmazonConfig.
Returns:
The response from the DescribeDeliveryChannels service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchDeliveryChannelException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.

NOTE:Currently, you can specify only one configuration recorder per account.

Parameters:
describeConfigurationRecorderStatusRequest Container for the necessary parameters to execute the DescribeConfigurationRecorderStatus service method on AmazonConfig.
Returns:
The response from the DescribeConfigurationRecorderStatus service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchConfigurationRecorderException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

NOTE:Currently, you can specify only one delivery channel per account.

Returns:
The response from the DescribeDeliveryChannelStatus service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchDeliveryChannelException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.

NOTE: Currently, you can specify only one configuration recorder per account.

Returns:
The response from the DescribeConfigurationRecorders service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchConfigurationRecorderException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

NOTE: Currently, you can specify only one delivery channel per account.

Returns:
The response from the DescribeDeliveryChannels service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchDeliveryChannelException
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 AmazonConfig indicating either a problem with the data in the request, or a server side issue.

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.

NOTE:Currently, you can specify only one configuration recorder per account.

Returns:
The response from the DescribeConfigurationRecorderStatus service method, as returned by AmazonConfig.
Throws:
com.amazonaws.services.config.model.NoSuchConfigurationRecorderException
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 AmazonConfig 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