configservice

package
v0.7.5-0...-852fe60 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 17, 2015 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package configservice provides a client for AWS Config.

Index

Examples

Constants

View Source
const (
	// @enum ChronologicalOrder
	ChronologicalOrderReverse = "Reverse"
	// @enum ChronologicalOrder
	ChronologicalOrderForward = "Forward"
)
View Source
const (
	// @enum ConfigurationItemStatus
	ConfigurationItemStatusOk = "Ok"
	// @enum ConfigurationItemStatus
	ConfigurationItemStatusFailed = "Failed"
	// @enum ConfigurationItemStatus
	ConfigurationItemStatusDiscovered = "Discovered"
	// @enum ConfigurationItemStatus
	ConfigurationItemStatusDeleted = "Deleted"
)
View Source
const (
	// @enum DeliveryStatus
	DeliveryStatusSuccess = "Success"
	// @enum DeliveryStatus
	DeliveryStatusFailure = "Failure"
	// @enum DeliveryStatus
	DeliveryStatusNotApplicable = "Not_Applicable"
)
View Source
const (
	// @enum RecorderStatus
	RecorderStatusPending = "Pending"
	// @enum RecorderStatus
	RecorderStatusSuccess = "Success"
	// @enum RecorderStatus
	RecorderStatusFailure = "Failure"
)
View Source
const (
	// @enum ResourceType
	ResourceTypeAwsEc2CustomerGateway = "AWS::EC2::CustomerGateway"
	// @enum ResourceType
	ResourceTypeAwsEc2Eip = "AWS::EC2::EIP"
	// @enum ResourceType
	ResourceTypeAwsEc2Instance = "AWS::EC2::Instance"
	// @enum ResourceType
	ResourceTypeAwsEc2InternetGateway = "AWS::EC2::InternetGateway"
	// @enum ResourceType
	ResourceTypeAwsEc2NetworkAcl = "AWS::EC2::NetworkAcl"
	// @enum ResourceType
	ResourceTypeAwsEc2NetworkInterface = "AWS::EC2::NetworkInterface"
	// @enum ResourceType
	ResourceTypeAwsEc2RouteTable = "AWS::EC2::RouteTable"
	// @enum ResourceType
	ResourceTypeAwsEc2SecurityGroup = "AWS::EC2::SecurityGroup"
	// @enum ResourceType
	ResourceTypeAwsEc2Subnet = "AWS::EC2::Subnet"
	// @enum ResourceType
	ResourceTypeAwsCloudTrailTrail = "AWS::CloudTrail::Trail"
	// @enum ResourceType
	ResourceTypeAwsEc2Volume = "AWS::EC2::Volume"
	// @enum ResourceType
	ResourceTypeAwsEc2Vpc = "AWS::EC2::VPC"
	// @enum ResourceType
	ResourceTypeAwsEc2Vpnconnection = "AWS::EC2::VPNConnection"
	// @enum ResourceType
	ResourceTypeAwsEc2Vpngateway = "AWS::EC2::VPNGateway"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ConfigExportDeliveryInfo

type ConfigExportDeliveryInfo struct {
	// The time of the last attempted delivery.
	LastAttemptTime *time.Time `locationName:"lastAttemptTime" type:"timestamp" timestampFormat:"unix"`

	// The error code from the last attempted delivery.
	LastErrorCode *string `locationName:"lastErrorCode" type:"string"`

	// The error message from the last attempted delivery.
	LastErrorMessage *string `locationName:"lastErrorMessage" type:"string"`

	// Status of the last attempted delivery.
	LastStatus *string `locationName:"lastStatus" type:"string" enum:"DeliveryStatus"`

	// The time of the last successful delivery.
	LastSuccessfulTime *time.Time `locationName:"lastSuccessfulTime" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

A list that contains the status of the delivery of either the snapshot or the configuration history to the specified Amazon S3 bucket.

func (ConfigExportDeliveryInfo) GoString

func (s ConfigExportDeliveryInfo) GoString() string

GoString returns the string representation

func (ConfigExportDeliveryInfo) String

func (s ConfigExportDeliveryInfo) String() string

String returns the string representation

type ConfigService

type ConfigService struct {
	*service.Service
}

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 (http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-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 (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

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? (http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html) in the AWS Config Developer Guide.

func New

func New(config *aws.Config) *ConfigService

New returns a new ConfigService client.

func (*ConfigService) DeleteDeliveryChannel

func (c *ConfigService) DeleteDeliveryChannel(input *DeleteDeliveryChannelInput) (*DeleteDeliveryChannelOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.DeleteDeliveryChannelInput{
		DeliveryChannelName: aws.String("ChannelName"), // Required
	}
	resp, err := svc.DeleteDeliveryChannel(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) DeleteDeliveryChannelRequest

func (c *ConfigService) DeleteDeliveryChannelRequest(input *DeleteDeliveryChannelInput) (req *service.Request, output *DeleteDeliveryChannelOutput)

DeleteDeliveryChannelRequest generates a request for the DeleteDeliveryChannel operation.

func (*ConfigService) DeliverConfigSnapshot

func (c *ConfigService) DeliverConfigSnapshot(input *DeliverConfigSnapshotInput) (*DeliverConfigSnapshotOutput, error)

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.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.DeliverConfigSnapshotInput{
		DeliveryChannelName: aws.String("ChannelName"), // Required
	}
	resp, err := svc.DeliverConfigSnapshot(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) DeliverConfigSnapshotRequest

func (c *ConfigService) DeliverConfigSnapshotRequest(input *DeliverConfigSnapshotInput) (req *service.Request, output *DeliverConfigSnapshotOutput)

DeliverConfigSnapshotRequest generates a request for the DeliverConfigSnapshot operation.

func (*ConfigService) DescribeConfigurationRecorderStatus

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.DescribeConfigurationRecorderStatusInput{
		ConfigurationRecorderNames: []*string{
			aws.String("RecorderName"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeConfigurationRecorderStatus(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) DescribeConfigurationRecorderStatusRequest

func (c *ConfigService) DescribeConfigurationRecorderStatusRequest(input *DescribeConfigurationRecorderStatusInput) (req *service.Request, output *DescribeConfigurationRecorderStatusOutput)

DescribeConfigurationRecorderStatusRequest generates a request for the DescribeConfigurationRecorderStatus operation.

func (*ConfigService) DescribeConfigurationRecorders

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.

Currently, you can specify only one configuration recorder per account.
Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.DescribeConfigurationRecordersInput{
		ConfigurationRecorderNames: []*string{
			aws.String("RecorderName"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeConfigurationRecorders(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) DescribeConfigurationRecordersRequest

func (c *ConfigService) DescribeConfigurationRecordersRequest(input *DescribeConfigurationRecordersInput) (req *service.Request, output *DescribeConfigurationRecordersOutput)

DescribeConfigurationRecordersRequest generates a request for the DescribeConfigurationRecorders operation.

func (*ConfigService) DescribeDeliveryChannelStatus

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.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.DescribeDeliveryChannelStatusInput{
		DeliveryChannelNames: []*string{
			aws.String("ChannelName"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeDeliveryChannelStatus(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) DescribeDeliveryChannelStatusRequest

func (c *ConfigService) DescribeDeliveryChannelStatusRequest(input *DescribeDeliveryChannelStatusInput) (req *service.Request, output *DescribeDeliveryChannelStatusOutput)

DescribeDeliveryChannelStatusRequest generates a request for the DescribeDeliveryChannelStatus operation.

func (*ConfigService) DescribeDeliveryChannels

func (c *ConfigService) DescribeDeliveryChannels(input *DescribeDeliveryChannelsInput) (*DescribeDeliveryChannelsOutput, error)

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.

Currently, you can specify only one delivery channel per account.
Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.DescribeDeliveryChannelsInput{
		DeliveryChannelNames: []*string{
			aws.String("ChannelName"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeDeliveryChannels(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) DescribeDeliveryChannelsRequest

func (c *ConfigService) DescribeDeliveryChannelsRequest(input *DescribeDeliveryChannelsInput) (req *service.Request, output *DescribeDeliveryChannelsOutput)

DescribeDeliveryChannelsRequest generates a request for the DescribeDeliveryChannels operation.

func (*ConfigService) GetResourceConfigHistory

func (c *ConfigService) GetResourceConfigHistory(input *GetResourceConfigHistoryInput) (*GetResourceConfigHistoryOutput, error)

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.

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 .

Example
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.GetResourceConfigHistoryInput{
		ResourceID:         aws.String("ResourceId"),   // Required
		ResourceType:       aws.String("ResourceType"), // Required
		ChronologicalOrder: aws.String("ChronologicalOrder"),
		EarlierTime:        aws.Time(time.Now()),
		LaterTime:          aws.Time(time.Now()),
		Limit:              aws.Int64(1),
		NextToken:          aws.String("NextToken"),
	}
	resp, err := svc.GetResourceConfigHistory(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) GetResourceConfigHistoryPages

func (c *ConfigService) GetResourceConfigHistoryPages(input *GetResourceConfigHistoryInput, fn func(p *GetResourceConfigHistoryOutput, lastPage bool) (shouldContinue bool)) error

func (*ConfigService) GetResourceConfigHistoryRequest

func (c *ConfigService) GetResourceConfigHistoryRequest(input *GetResourceConfigHistoryInput) (req *service.Request, output *GetResourceConfigHistoryOutput)

GetResourceConfigHistoryRequest generates a request for the GetResourceConfigHistory operation.

func (*ConfigService) PutConfigurationRecorder

func (c *ConfigService) PutConfigurationRecorder(input *PutConfigurationRecorderInput) (*PutConfigurationRecorderOutput, error)

Creates a new configuration recorder to record the selected resource configurations.

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

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

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.PutConfigurationRecorderInput{
		ConfigurationRecorder: &configservice.ConfigurationRecorder{ // Required
			Name: aws.String("RecorderName"),
			RecordingGroup: &configservice.RecordingGroup{
				AllSupported: aws.Bool(true),
				ResourceTypes: []*string{
					aws.String("ResourceType"), // Required
					// More values...
				},
			},
			RoleARN: aws.String("String"),
		},
	}
	resp, err := svc.PutConfigurationRecorder(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) PutConfigurationRecorderRequest

func (c *ConfigService) PutConfigurationRecorderRequest(input *PutConfigurationRecorderInput) (req *service.Request, output *PutConfigurationRecorderOutput)

PutConfigurationRecorderRequest generates a request for the PutConfigurationRecorder operation.

func (*ConfigService) PutDeliveryChannel

func (c *ConfigService) PutDeliveryChannel(input *PutDeliveryChannelInput) (*PutDeliveryChannelOutput, error)

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.

Currently, you can specify only one delivery channel per account.
Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.PutDeliveryChannelInput{
		DeliveryChannel: &configservice.DeliveryChannel{ // Required
			Name:         aws.String("ChannelName"),
			S3BucketName: aws.String("String"),
			S3KeyPrefix:  aws.String("String"),
			SNSTopicARN:  aws.String("String"),
		},
	}
	resp, err := svc.PutDeliveryChannel(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) PutDeliveryChannelRequest

func (c *ConfigService) PutDeliveryChannelRequest(input *PutDeliveryChannelInput) (req *service.Request, output *PutDeliveryChannelOutput)

PutDeliveryChannelRequest generates a request for the PutDeliveryChannel operation.

func (*ConfigService) StartConfigurationRecorder

func (c *ConfigService) StartConfigurationRecorder(input *StartConfigurationRecorderInput) (*StartConfigurationRecorderOutput, error)

Starts recording configurations of the AWS resources you have selected to record in your AWS account.

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

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.StartConfigurationRecorderInput{
		ConfigurationRecorderName: aws.String("RecorderName"), // Required
	}
	resp, err := svc.StartConfigurationRecorder(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) StartConfigurationRecorderRequest

func (c *ConfigService) StartConfigurationRecorderRequest(input *StartConfigurationRecorderInput) (req *service.Request, output *StartConfigurationRecorderOutput)

StartConfigurationRecorderRequest generates a request for the StartConfigurationRecorder operation.

func (*ConfigService) StopConfigurationRecorder

func (c *ConfigService) StopConfigurationRecorder(input *StopConfigurationRecorderInput) (*StopConfigurationRecorderOutput, error)

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/awsutil"
	"github.com/aws/aws-sdk-go/service/configservice"
)

func main() {
	svc := configservice.New(nil)

	params := &configservice.StopConfigurationRecorderInput{
		ConfigurationRecorderName: aws.String("RecorderName"), // Required
	}
	resp, err := svc.StopConfigurationRecorder(params)

	if err != nil {
		if awsErr, ok := err.(awserr.Error); ok {
			// Generic AWS error with Code, Message, and original error (if any)
			fmt.Println(awsErr.Code(), awsErr.Message(), awsErr.OrigErr())
			if reqErr, ok := err.(awserr.RequestFailure); ok {
				// A service error occurred
				fmt.Println(reqErr.Code(), reqErr.Message(), reqErr.StatusCode(), reqErr.RequestID())
			}
		} else {
			// This case should never be hit, the SDK should always return an
			// error which satisfies the awserr.Error interface.
			fmt.Println(err.Error())
		}
	}

	// Pretty-print the response data.
	fmt.Println(awsutil.Prettify(resp))
}
Output:

func (*ConfigService) StopConfigurationRecorderRequest

func (c *ConfigService) StopConfigurationRecorderRequest(input *StopConfigurationRecorderInput) (req *service.Request, output *StopConfigurationRecorderOutput)

StopConfigurationRecorderRequest generates a request for the StopConfigurationRecorder operation.

type ConfigStreamDeliveryInfo

type ConfigStreamDeliveryInfo struct {
	// The error code from the last attempted delivery.
	LastErrorCode *string `locationName:"lastErrorCode" type:"string"`

	// The error message from the last attempted delivery.
	LastErrorMessage *string `locationName:"lastErrorMessage" type:"string"`

	// Status of the last attempted delivery.
	//
	// Note Providing an SNS topic on a DeliveryChannel (http://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html)
	// for AWS Config is optional. If the SNS delivery is turned off, the last status
	// will be Not_Applicable.
	LastStatus *string `locationName:"lastStatus" type:"string" enum:"DeliveryStatus"`

	// The time from the last status change.
	LastStatusChangeTime *time.Time `locationName:"lastStatusChangeTime" type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

func (ConfigStreamDeliveryInfo) GoString

func (s ConfigStreamDeliveryInfo) GoString() string

GoString returns the string representation

func (ConfigStreamDeliveryInfo) String

func (s ConfigStreamDeliveryInfo) String() string

String returns the string representation

type ConfigurationItem

type ConfigurationItem struct {
	// The Amazon Resource Name (ARN) of the resource.
	ARN *string `locationName:"arn" type:"string"`

	// The 12 digit AWS account ID associated with the resource.
	AccountID *string `locationName:"accountId" type:"string"`

	// The Availability Zone associated with the resource.
	AvailabilityZone *string `locationName:"availabilityZone" type:"string"`

	// The description of the resource configuration.
	Configuration *string `locationName:"configuration" type:"string"`

	// The time when the configuration recording was initiated.
	ConfigurationItemCaptureTime *time.Time `locationName:"configurationItemCaptureTime" type:"timestamp" timestampFormat:"unix"`

	// Unique MD5 hash that represents the configuration item's state.
	//
	// You can use MD5 hash to compare the states of two or more configuration
	// items that are associated with the same resource.
	ConfigurationItemMD5Hash *string `locationName:"configurationItemMD5Hash" type:"string"`

	// The configuration item status.
	ConfigurationItemStatus *string `locationName:"configurationItemStatus" type:"string" enum:"ConfigurationItemStatus"`

	// An identifier that indicates the ordering of the configuration items of a
	// resource.
	ConfigurationStateID *string `locationName:"configurationStateId" type:"string"`

	// A list of CloudTrail event IDs.
	//
	// A populated field indicates that the current configuration was initiated
	// by the events recorded in the CloudTrail log. For more information about
	// CloudTrail, see What is AWS CloudTrail? (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html).
	//
	// An empty field indicates that the current configuration was not initiated
	// by any event.
	RelatedEvents []*string `locationName:"relatedEvents" type:"list"`

	// A list of related AWS resources.
	Relationships []*Relationship `locationName:"relationships" type:"list"`

	// The time stamp when the resource was created.
	ResourceCreationTime *time.Time `locationName:"resourceCreationTime" type:"timestamp" timestampFormat:"unix"`

	// The ID of the resource (for example., sg-xxxxxx).
	ResourceID *string `locationName:"resourceId" type:"string"`

	// The type of AWS resource.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`

	// A mapping of key value tags associated with the resource.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The version number of the resource configuration.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

A list that contains detailed configurations of a specified resource.

Currently, the list does not contain information about non-AWS components

(for example, applications on your Amazon EC2 instances).

func (ConfigurationItem) GoString

func (s ConfigurationItem) GoString() string

GoString returns the string representation

func (ConfigurationItem) String

func (s ConfigurationItem) String() string

String returns the string representation

type ConfigurationRecorder

type ConfigurationRecorder struct {
	// The name of the recorder. By default, AWS Config automatically assigns the
	// name "default" when creating the configuration recorder. You cannot change
	// the assigned name.
	Name *string `locationName:"name" type:"string"`

	// The recording group specifies either to record configurations for all supported
	// resources or to provide a list of resource types to record. The list of resource
	// types must be a subset of supported resource types.
	RecordingGroup *RecordingGroup `locationName:"recordingGroup" type:"structure"`

	// Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources
	// associated with the account.
	RoleARN *string `locationName:"roleARN" type:"string"`
	// contains filtered or unexported fields
}

An object that represents the recording of configuration changes of an AWS resource.

func (ConfigurationRecorder) GoString

func (s ConfigurationRecorder) GoString() string

GoString returns the string representation

func (ConfigurationRecorder) String

func (s ConfigurationRecorder) String() string

String returns the string representation

type ConfigurationRecorderStatus

type ConfigurationRecorderStatus struct {
	// The error code indicating that the recording failed.
	LastErrorCode *string `locationName:"lastErrorCode" type:"string"`

	// The message indicating that the recording failed due to an error.
	LastErrorMessage *string `locationName:"lastErrorMessage" type:"string"`

	// The time the recorder was last started.
	LastStartTime *time.Time `locationName:"lastStartTime" type:"timestamp" timestampFormat:"unix"`

	// The last (previous) status of the recorder.
	LastStatus *string `locationName:"lastStatus" type:"string" enum:"RecorderStatus"`

	// The time when the status was last changed.
	LastStatusChangeTime *time.Time `locationName:"lastStatusChangeTime" type:"timestamp" timestampFormat:"unix"`

	// The time the recorder was last stopped.
	LastStopTime *time.Time `locationName:"lastStopTime" type:"timestamp" timestampFormat:"unix"`

	// The name of the configuration recorder.
	Name *string `locationName:"name" type:"string"`

	// Specifies whether the recorder is currently recording or not.
	Recording *bool `locationName:"recording" type:"boolean"`
	// contains filtered or unexported fields
}

The current status of the configuration recorder.

func (ConfigurationRecorderStatus) GoString

func (s ConfigurationRecorderStatus) GoString() string

GoString returns the string representation

func (ConfigurationRecorderStatus) String

String returns the string representation

type DeleteDeliveryChannelInput

type DeleteDeliveryChannelInput struct {
	// The name of the delivery channel to delete.
	DeliveryChannelName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DeleteDeliveryChannel action. The action accepts the following data in JSON format.

func (DeleteDeliveryChannelInput) GoString

func (s DeleteDeliveryChannelInput) GoString() string

GoString returns the string representation

func (DeleteDeliveryChannelInput) String

String returns the string representation

type DeleteDeliveryChannelOutput

type DeleteDeliveryChannelOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDeliveryChannelOutput) GoString

func (s DeleteDeliveryChannelOutput) GoString() string

GoString returns the string representation

func (DeleteDeliveryChannelOutput) String

String returns the string representation

type DeliverConfigSnapshotInput

type DeliverConfigSnapshotInput struct {
	// The name of the delivery channel through which the snapshot is delivered.
	DeliveryChannelName *string `locationName:"deliveryChannelName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the DeliverConfigSnapshot action.

func (DeliverConfigSnapshotInput) GoString

func (s DeliverConfigSnapshotInput) GoString() string

GoString returns the string representation

func (DeliverConfigSnapshotInput) String

String returns the string representation

type DeliverConfigSnapshotOutput

type DeliverConfigSnapshotOutput struct {
	// The ID of the snapshot that is being created.
	ConfigSnapshotID *string `locationName:"configSnapshotId" type:"string"`
	// contains filtered or unexported fields
}

The output for the DeliverConfigSnapshot action in JSON format.

func (DeliverConfigSnapshotOutput) GoString

func (s DeliverConfigSnapshotOutput) GoString() string

GoString returns the string representation

func (DeliverConfigSnapshotOutput) String

String returns the string representation

type DeliveryChannel

type DeliveryChannel struct {
	// The name of the delivery channel. By default, AWS Config automatically assigns
	// the name "default" when creating the delivery channel. You cannot change
	// the assigned name.
	Name *string `locationName:"name" type:"string"`

	// The name of the Amazon S3 bucket used to store configuration history for
	// the delivery channel.
	S3BucketName *string `locationName:"s3BucketName" type:"string"`

	// The prefix for the specified Amazon S3 bucket.
	S3KeyPrefix *string `locationName:"s3KeyPrefix" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role used for accessing the Amazon
	// S3 bucket and the Amazon SNS topic.
	SNSTopicARN *string `locationName:"snsTopicARN" type:"string"`
	// contains filtered or unexported fields
}

A logical container used for storing the configuration changes of an AWS resource.

func (DeliveryChannel) GoString

func (s DeliveryChannel) GoString() string

GoString returns the string representation

func (DeliveryChannel) String

func (s DeliveryChannel) String() string

String returns the string representation

type DeliveryChannelStatus

type DeliveryChannelStatus struct {
	// A list that contains the status of the delivery of the configuration history
	// to the specified Amazon S3 bucket.
	ConfigHistoryDeliveryInfo *ConfigExportDeliveryInfo `locationName:"configHistoryDeliveryInfo" type:"structure"`

	// A list containing the status of the delivery of the snapshot to the specified
	// Amazon S3 bucket.
	ConfigSnapshotDeliveryInfo *ConfigExportDeliveryInfo `locationName:"configSnapshotDeliveryInfo" type:"structure"`

	// A list containing the status of the delivery of the configuration stream
	// notification to the specified Amazon SNS topic.
	ConfigStreamDeliveryInfo *ConfigStreamDeliveryInfo `locationName:"configStreamDeliveryInfo" type:"structure"`

	// The name of the delivery channel.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

The status of a specified delivery channel.

Valid values: Success | Failure

func (DeliveryChannelStatus) GoString

func (s DeliveryChannelStatus) GoString() string

GoString returns the string representation

func (DeliveryChannelStatus) String

func (s DeliveryChannelStatus) String() string

String returns the string representation

type DescribeConfigurationRecorderStatusInput

type DescribeConfigurationRecorderStatusInput struct {
	// The name(s) of the configuration recorder. If the name is not specified,
	// the action returns the current status of all the configuration recorders
	// associated with the account.
	ConfigurationRecorderNames []*string `type:"list"`
	// contains filtered or unexported fields
}

The input for the DescribeConfigurationRecorderStatus action.

func (DescribeConfigurationRecorderStatusInput) GoString

GoString returns the string representation

func (DescribeConfigurationRecorderStatusInput) String

String returns the string representation

type DescribeConfigurationRecorderStatusOutput

type DescribeConfigurationRecorderStatusOutput struct {
	// A list that contains status of the specified recorders.
	ConfigurationRecordersStatus []*ConfigurationRecorderStatus `type:"list"`
	// contains filtered or unexported fields
}

The output for the DescribeConfigurationRecorderStatus action in JSON format.

func (DescribeConfigurationRecorderStatusOutput) GoString

GoString returns the string representation

func (DescribeConfigurationRecorderStatusOutput) String

String returns the string representation

type DescribeConfigurationRecordersInput

type DescribeConfigurationRecordersInput struct {
	// A list of configuration recorder names.
	ConfigurationRecorderNames []*string `type:"list"`
	// contains filtered or unexported fields
}

The input for the DescribeConfigurationRecorders action.

func (DescribeConfigurationRecordersInput) GoString

GoString returns the string representation

func (DescribeConfigurationRecordersInput) String

String returns the string representation

type DescribeConfigurationRecordersOutput

type DescribeConfigurationRecordersOutput struct {
	// A list that contains the descriptions of the specified configuration recorders.
	ConfigurationRecorders []*ConfigurationRecorder `type:"list"`
	// contains filtered or unexported fields
}

The output for the DescribeConfigurationRecorders action.

func (DescribeConfigurationRecordersOutput) GoString

GoString returns the string representation

func (DescribeConfigurationRecordersOutput) String

String returns the string representation

type DescribeDeliveryChannelStatusInput

type DescribeDeliveryChannelStatusInput struct {
	// A list of delivery channel names.
	DeliveryChannelNames []*string `type:"list"`
	// contains filtered or unexported fields
}

The input for the DeliveryChannelStatus action.

func (DescribeDeliveryChannelStatusInput) GoString

GoString returns the string representation

func (DescribeDeliveryChannelStatusInput) String

String returns the string representation

type DescribeDeliveryChannelStatusOutput

type DescribeDeliveryChannelStatusOutput struct {
	// A list that contains the status of a specified delivery channel.
	DeliveryChannelsStatus []*DeliveryChannelStatus `type:"list"`
	// contains filtered or unexported fields
}

The output for the DescribeDeliveryChannelStatus action.

func (DescribeDeliveryChannelStatusOutput) GoString

GoString returns the string representation

func (DescribeDeliveryChannelStatusOutput) String

String returns the string representation

type DescribeDeliveryChannelsInput

type DescribeDeliveryChannelsInput struct {
	// A list of delivery channel names.
	DeliveryChannelNames []*string `type:"list"`
	// contains filtered or unexported fields
}

The input for the DescribeDeliveryChannels action.

func (DescribeDeliveryChannelsInput) GoString

GoString returns the string representation

func (DescribeDeliveryChannelsInput) String

String returns the string representation

type DescribeDeliveryChannelsOutput

type DescribeDeliveryChannelsOutput struct {
	// A list that contains the descriptions of the specified delivery channel.
	DeliveryChannels []*DeliveryChannel `type:"list"`
	// contains filtered or unexported fields
}

The output for the DescribeDeliveryChannels action.

func (DescribeDeliveryChannelsOutput) GoString

GoString returns the string representation

func (DescribeDeliveryChannelsOutput) String

String returns the string representation

type GetResourceConfigHistoryInput

type GetResourceConfigHistoryInput struct {
	// The chronological order for configuration items listed. By default the results
	// are listed in reverse chronological order.
	ChronologicalOrder *string `locationName:"chronologicalOrder" type:"string" enum:"ChronologicalOrder"`

	// The time stamp that indicates an earlier time. If not specified, the action
	// returns paginated results that contain configuration items that start from
	// when the first configuration item was recorded.
	EarlierTime *time.Time `locationName:"earlierTime" type:"timestamp" timestampFormat:"unix"`

	// The time stamp that indicates a later time. If not specified, current time
	// is taken.
	LaterTime *time.Time `locationName:"laterTime" type:"timestamp" timestampFormat:"unix"`

	// The maximum number of configuration items returned in each page. The default
	// is 10. You cannot specify a limit greater than 100.
	Limit *int64 `locationName:"limit" type:"integer"`

	// An optional parameter used for pagination of the results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The ID of the resource (for example., sg-xxxxxx).
	ResourceID *string `locationName:"resourceId" type:"string" required:"true"`

	// The resource type.
	ResourceType *string `locationName:"resourceType" type:"string" required:"true" enum:"ResourceType"`
	// contains filtered or unexported fields
}

The input for the GetResourceConfigHistory action.

func (GetResourceConfigHistoryInput) GoString

GoString returns the string representation

func (GetResourceConfigHistoryInput) String

String returns the string representation

type GetResourceConfigHistoryOutput

type GetResourceConfigHistoryOutput struct {
	// A list that contains the configuration history of one or more resources.
	ConfigurationItems []*ConfigurationItem `locationName:"configurationItems" type:"list"`

	// A token used for pagination of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

The output for the GetResourceConfigHistory action.

func (GetResourceConfigHistoryOutput) GoString

GoString returns the string representation

func (GetResourceConfigHistoryOutput) String

String returns the string representation

type PutConfigurationRecorderInput

type PutConfigurationRecorderInput struct {
	// The configuration recorder object that records each configuration change
	// made to the resources.
	ConfigurationRecorder *ConfigurationRecorder `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The input for the PutConfigurationRecorder action.

func (PutConfigurationRecorderInput) GoString

GoString returns the string representation

func (PutConfigurationRecorderInput) String

String returns the string representation

type PutConfigurationRecorderOutput

type PutConfigurationRecorderOutput struct {
	// contains filtered or unexported fields
}

func (PutConfigurationRecorderOutput) GoString

GoString returns the string representation

func (PutConfigurationRecorderOutput) String

String returns the string representation

type PutDeliveryChannelInput

type PutDeliveryChannelInput struct {
	// The configuration delivery channel object that delivers the configuration
	// information to an Amazon S3 bucket, and to an Amazon SNS topic.
	DeliveryChannel *DeliveryChannel `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The input for the PutDeliveryChannel action.

func (PutDeliveryChannelInput) GoString

func (s PutDeliveryChannelInput) GoString() string

GoString returns the string representation

func (PutDeliveryChannelInput) String

func (s PutDeliveryChannelInput) String() string

String returns the string representation

type PutDeliveryChannelOutput

type PutDeliveryChannelOutput struct {
	// contains filtered or unexported fields
}

func (PutDeliveryChannelOutput) GoString

func (s PutDeliveryChannelOutput) GoString() string

GoString returns the string representation

func (PutDeliveryChannelOutput) String

func (s PutDeliveryChannelOutput) String() string

String returns the string representation

type RecordingGroup

type RecordingGroup struct {
	// Records all supported resource types in the recording group. For a list of
	// supported resource types, see Supported resource types (http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources).
	// If you specify allSupported, you cannot enumerate a list of resourceTypes.
	AllSupported *bool `locationName:"allSupported" type:"boolean"`

	// A comma-separated list of strings representing valid AWS resource types (e.g.,
	// AWS::EC2::Instance or AWS::CloudTrail::Trail). resourceTypes is only valid
	// if you have chosen not to select allSupported. For a list of valid resourceTypes
	// values, see the resourceType Value column in the following topic: Supported
	// AWS Resource Types (http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources).
	ResourceTypes []*string `locationName:"resourceTypes" type:"list"`
	// contains filtered or unexported fields
}

The group of AWS resource types that AWS Config records when starting the configuration recorder.

recordingGroup can have one and only one parameter. Choose either allSupported or resourceTypes.

func (RecordingGroup) GoString

func (s RecordingGroup) GoString() string

GoString returns the string representation

func (RecordingGroup) String

func (s RecordingGroup) String() string

String returns the string representation

type Relationship

type Relationship struct {
	// The name of the related resource.
	RelationshipName *string `locationName:"relationshipName" type:"string"`

	// The resource ID of the related resource (for example, sg-xxxxxx).
	ResourceID *string `locationName:"resourceId" type:"string"`

	// The resource type of the related resource.
	ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

The relationship of the related resource to the main resource.

func (Relationship) GoString

func (s Relationship) GoString() string

GoString returns the string representation

func (Relationship) String

func (s Relationship) String() string

String returns the string representation

type StartConfigurationRecorderInput

type StartConfigurationRecorderInput struct {
	// The name of the recorder object that records each configuration change made
	// to the resources.
	ConfigurationRecorderName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the StartConfigurationRecorder action.

func (StartConfigurationRecorderInput) GoString

GoString returns the string representation

func (StartConfigurationRecorderInput) String

String returns the string representation

type StartConfigurationRecorderOutput

type StartConfigurationRecorderOutput struct {
	// contains filtered or unexported fields
}

func (StartConfigurationRecorderOutput) GoString

GoString returns the string representation

func (StartConfigurationRecorderOutput) String

String returns the string representation

type StopConfigurationRecorderInput

type StopConfigurationRecorderInput struct {
	// The name of the recorder object that records each configuration change made
	// to the resources.
	ConfigurationRecorderName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the StopConfigurationRecorder action.

func (StopConfigurationRecorderInput) GoString

GoString returns the string representation

func (StopConfigurationRecorderInput) String

String returns the string representation

type StopConfigurationRecorderOutput

type StopConfigurationRecorderOutput struct {
	// contains filtered or unexported fields
}

func (StopConfigurationRecorderOutput) GoString

GoString returns the string representation

func (StopConfigurationRecorderOutput) String

String returns the string representation

Directories

Path Synopsis
Package configserviceiface provides an interface for the AWS Config.
Package configserviceiface provides an interface for the AWS Config.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL