doc.go

// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.

// Package cloudwatchevents provides the client and types for making API
// requests to Amazon CloudWatch Events.
//
// Amazon CloudWatch Events helps you to respond to state changes in your AWS
// resources. When your resources change state, they automatically send events
// into an event stream. You can create rules that match selected events in
// the stream and route them to targets to take action. You can also use rules
// to take action on a pre-determined schedule. For example, you can configure
// rules to:
//
//    * Automatically invoke an AWS Lambda function to update DNS entries when
//    an event notifies you that Amazon EC2 instance enters the running state.
//
//    * Direct specific API records from CloudTrail to an Amazon Kinesis stream
//    for detailed analysis of potential security or availability risks.
//
//    * Periodically invoke a built-in target to create a snapshot of an Amazon
//    EBS volume.
//
// For more information about the features of Amazon CloudWatch Events, see
// the Amazon CloudWatch Events User Guide (http://docs.aws.amazon.com/AmazonCloudWatch/latest/events).
//
// See https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07 for more information on this service.
//
// See cloudwatchevents package documentation for more information.
// https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchevents/
//
// Using the Client
//
// To use the client for Amazon CloudWatch Events you will first need
// to create a new instance of it.
//
// When creating a client for an AWS service you'll first need to have a Session
// already created. The Session provides configuration that can be shared
// between multiple service clients. Additional configuration can be applied to
// the Session and service's client when they are constructed. The aws package's
// Config type contains several fields such as Region for the AWS Region the
// client should make API requests too. The optional Config value can be provided
// as the variadic argument for Sessions and client creation.
//
// Once the service's client is created you can use it to make API requests the
// AWS service. These clients are safe to use concurrently.
//
//   // Create a session to share configuration, and load external configuration.
//   sess := session.Must(session.NewSession())
//
//   // Create the service's client with the session.
//   svc := cloudwatchevents.New(sess)
//
// See the SDK's documentation for more information on how to use service clients.
// https://docs.aws.amazon.com/sdk-for-go/api/
//
// See aws package's Config type for more information on configuration options.
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
//
// See the Amazon CloudWatch Events client CloudWatchEvents for more
// information on creating the service's client.
// https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchevents/#New
//
// Once the client is created you can make an API request to the service.
// Each API method takes a input parameter, and returns the service response
// and an error.
//
// The API method will document which error codes the service can be returned
// by the operation if the service models the API operation's errors. These
// errors will also be available as const strings prefixed with "ErrCode".
//
//   result, err := svc.DeleteRule(params)
//   if err != nil {
//       // Cast err to awserr.Error to handle specific error codes.
//       aerr, ok := err.(awserr.Error)
//       if ok && aerr.Code() == <error code to check for> {
//           // Specific error code handling
//       }
//       return err
//   }
//
//   fmt.Println("DeleteRule result:")
//   fmt.Println(result)
//
// Using the Client with Context
//
// The service's client also provides methods to make API requests with a Context
// value. This allows you to control the timeout, and cancellation of pending
// requests. These methods also take request Option as variadic parameter to apply
// additional configuration to the API request.
//
//   ctx := context.Background()
//
//   result, err := svc.DeleteRuleWithContext(ctx, params)
//
// See the request package documentation for more information on using Context pattern
// with the SDK.
// https://docs.aws.amazon.com/sdk-for-go/api/aws/request/
package cloudwatchevents