cloudwatchevents

package
v1.1.23-0...-7761b2c Latest Latest
Warning

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

 Go to latest Published: May 3, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package cloudwatchevents provides a client for Amazon CloudWatch Events.

Index

Examples

Constants

View Source 
const (
	// @enum RuleState
	RuleStateEnabled = "ENABLED"
	// @enum RuleState
	RuleStateDisabled = "DISABLED"
)
View Source 
const ServiceName = "events"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type CloudWatchEvents 

type CloudWatchEvents struct {
	*client.Client
}

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 Amazon CloudWatch Events features, see the Amazon CloudWatch Developer Guide (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudWatchEvents

New creates a new instance of the CloudWatchEvents client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a CloudWatchEvents client from just a session.
svc := cloudwatchevents.New(mySession)

// Create a CloudWatchEvents client with additional configuration
svc := cloudwatchevents.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudWatchEvents) DeleteRule 

func (c *CloudWatchEvents) DeleteRule(input *DeleteRuleInput) (*DeleteRuleOutput, error)

Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule. 

Note: When you delete a rule, incoming events might still continue to match

to the deleted rule. Please allow a short period of time for changes to take effect.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.DeleteRuleInput{
		Name: aws.String("RuleName"), // Required
	}
	resp, err := svc.DeleteRule(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) DeleteRuleRequest 

func (c *CloudWatchEvents) DeleteRuleRequest(input *DeleteRuleInput) (req *request.Request, output *DeleteRuleOutput)

DeleteRuleRequest generates a request for the DeleteRule operation.

func (*CloudWatchEvents) DescribeRule 

func (c *CloudWatchEvents) DescribeRule(input *DescribeRuleInput) (*DescribeRuleOutput, error)

Describes the details of the specified rule.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.DescribeRuleInput{
		Name: aws.String("RuleName"), // Required
	}
	resp, err := svc.DescribeRule(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) DescribeRuleRequest 

func (c *CloudWatchEvents) DescribeRuleRequest(input *DescribeRuleInput) (req *request.Request, output *DescribeRuleOutput)

DescribeRuleRequest generates a request for the DescribeRule operation.

func (*CloudWatchEvents) DisableRule 

func (c *CloudWatchEvents) DisableRule(input *DisableRuleInput) (*DisableRuleOutput, error)

Disables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression. 

Note: When you disable a rule, incoming events might still continue to

match to the disabled rule. Please allow a short period of time for changes to take effect.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.DisableRuleInput{
		Name: aws.String("RuleName"), // Required
	}
	resp, err := svc.DisableRule(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) DisableRuleRequest 

func (c *CloudWatchEvents) DisableRuleRequest(input *DisableRuleInput) (req *request.Request, output *DisableRuleOutput)

DisableRuleRequest generates a request for the DisableRule operation.

func (*CloudWatchEvents) EnableRule 

func (c *CloudWatchEvents) EnableRule(input *EnableRuleInput) (*EnableRuleOutput, error)

Enables a rule. If the rule does not exist, the operation fails. 

Note: When you enable a rule, incoming events might not immediately start

matching to a newly enabled rule. Please allow a short period of time for changes to take effect.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.EnableRuleInput{
		Name: aws.String("RuleName"), // Required
	}
	resp, err := svc.EnableRule(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) EnableRuleRequest 

func (c *CloudWatchEvents) EnableRuleRequest(input *EnableRuleInput) (req *request.Request, output *EnableRuleOutput)

EnableRuleRequest generates a request for the EnableRule operation.

func (*CloudWatchEvents) ListRuleNamesByTarget 

func (c *CloudWatchEvents) ListRuleNamesByTarget(input *ListRuleNamesByTargetInput) (*ListRuleNamesByTargetOutput, error)

Lists the names of the rules that the given target is put to. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRulesByTarget until the NextToken in the response is returned as null.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.ListRuleNamesByTargetInput{
		TargetArn: aws.String("TargetArn"), // Required
		Limit:     aws.Int64(1),
		NextToken: aws.String("NextToken"),
	}
	resp, err := svc.ListRuleNamesByTarget(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) ListRuleNamesByTargetRequest 

func (c *CloudWatchEvents) ListRuleNamesByTargetRequest(input *ListRuleNamesByTargetInput) (req *request.Request, output *ListRuleNamesByTargetOutput)

ListRuleNamesByTargetRequest generates a request for the ListRuleNamesByTarget operation.

func (*CloudWatchEvents) ListRules 

func (c *CloudWatchEvents) ListRules(input *ListRulesInput) (*ListRulesOutput, error)

Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.ListRulesInput{
		Limit:      aws.Int64(1),
		NamePrefix: aws.String("RuleName"),
		NextToken:  aws.String("NextToken"),
	}
	resp, err := svc.ListRules(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) ListRulesRequest 

func (c *CloudWatchEvents) ListRulesRequest(input *ListRulesInput) (req *request.Request, output *ListRulesOutput)

ListRulesRequest generates a request for the ListRules operation.

func (*CloudWatchEvents) ListTargetsByRule 

func (c *CloudWatchEvents) ListTargetsByRule(input *ListTargetsByRuleInput) (*ListTargetsByRuleOutput, error)

Lists of targets assigned to the rule.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.ListTargetsByRuleInput{
		Rule:      aws.String("RuleName"), // Required
		Limit:     aws.Int64(1),
		NextToken: aws.String("NextToken"),
	}
	resp, err := svc.ListTargetsByRule(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) ListTargetsByRuleRequest 

func (c *CloudWatchEvents) ListTargetsByRuleRequest(input *ListTargetsByRuleInput) (req *request.Request, output *ListTargetsByRuleOutput)

ListTargetsByRuleRequest generates a request for the ListTargetsByRule operation.

func (*CloudWatchEvents) PutEvents 

func (c *CloudWatchEvents) PutEvents(input *PutEventsInput) (*PutEventsOutput, error)

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

Example 
package main

import (
	"fmt"
	"time"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.PutEventsInput{
		Entries: []*cloudwatchevents.PutEventsRequestEntry{ // Required
			{ // Required
				Detail:     aws.String("String"),
				DetailType: aws.String("String"),
				Resources: []*string{
					aws.String("EventResource"), // Required
					// More values...
				},
				Source: aws.String("String"),
				Time:   aws.Time(time.Now()),
			},
			// More values...
		},
	}
	resp, err := svc.PutEvents(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) PutEventsRequest 

func (c *CloudWatchEvents) PutEventsRequest(input *PutEventsInput) (req *request.Request, output *PutEventsOutput)

PutEventsRequest generates a request for the PutEvents operation.

func (*CloudWatchEvents) PutRule 

func (c *CloudWatchEvents) PutRule(input *PutRuleInput) (*PutRuleOutput, error)

Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule. 

Note: When you create or update a rule, incoming events might not immediately

start matching to new or updated rules. Please allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule will trigger on matching events as well as on a schedule. 

Note: Most services in AWS treat : or / as the same character in Amazon

Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.PutRuleInput{
		Name:               aws.String("RuleName"), // Required
		Description:        aws.String("RuleDescription"),
		EventPattern:       aws.String("EventPattern"),
		RoleArn:            aws.String("RoleArn"),
		ScheduleExpression: aws.String("ScheduleExpression"),
		State:              aws.String("RuleState"),
	}
	resp, err := svc.PutRule(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) PutRuleRequest 

func (c *CloudWatchEvents) PutRuleRequest(input *PutRuleInput) (req *request.Request, output *PutRuleOutput)

PutRuleRequest generates a request for the PutRule operation.

func (*CloudWatchEvents) PutTargets 

func (c *CloudWatchEvents) PutTargets(input *PutTargetsInput) (*PutTargetsOutput, error)

Adds target(s) to a rule. Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.

In order to be able to make API calls against the resources you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For Amazon Kinesis streams, CloudWatch Events relies on IAM roles. For more information, see Permissions for Sending Events to Targets (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/EventsTargetPermissions.html) in the Amazon CloudWatch Developer Guide.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target: 

Neither Input nor InputPath is specified, then the entire event is passed

to the target in JSON form. InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed). 

Input is specified in the form of a valid JSON, then the matched event

is overridden with this constant. Note: When you add targets to a rule, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.PutTargetsInput{
		Rule: aws.String("RuleName"), // Required
		Targets: []*cloudwatchevents.Target{ // Required
			{ // Required
				Arn:       aws.String("TargetArn"), // Required
				Id:        aws.String("TargetId"),  // Required
				Input:     aws.String("TargetInput"),
				InputPath: aws.String("TargetInputPath"),
			},
			// More values...
		},
	}
	resp, err := svc.PutTargets(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) PutTargetsRequest 

func (c *CloudWatchEvents) PutTargetsRequest(input *PutTargetsInput) (req *request.Request, output *PutTargetsOutput)

PutTargetsRequest generates a request for the PutTargets operation.

func (*CloudWatchEvents) RemoveTargets 

func (c *CloudWatchEvents) RemoveTargets(input *RemoveTargetsInput) (*RemoveTargetsOutput, error)

Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked. 

Note: When you remove a target, when the associated rule triggers, removed

targets might still continue to be invoked. Please allow a short period of time for changes to take effect.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.RemoveTargetsInput{
		Ids: []*string{ // Required
			aws.String("TargetId"), // Required
			// More values...
		},
		Rule: aws.String("RuleName"), // Required
	}
	resp, err := svc.RemoveTargets(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) RemoveTargetsRequest 

func (c *CloudWatchEvents) RemoveTargetsRequest(input *RemoveTargetsInput) (req *request.Request, output *RemoveTargetsOutput)

RemoveTargetsRequest generates a request for the RemoveTargets operation.

func (*CloudWatchEvents) TestEventPattern 

func (c *CloudWatchEvents) TestEventPattern(input *TestEventPatternInput) (*TestEventPatternOutput, error)

Tests whether an event pattern matches the provided event. 

Note: Most services in AWS treat : or / as the same character in Amazon

Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudwatchevents"
)

func main() {
	svc := cloudwatchevents.New(session.New())

	params := &cloudwatchevents.TestEventPatternInput{
		Event:        aws.String("String"),       // Required
		EventPattern: aws.String("EventPattern"), // Required
	}
	resp, err := svc.TestEventPattern(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudWatchEvents) TestEventPatternRequest 

func (c *CloudWatchEvents) TestEventPatternRequest(input *TestEventPatternInput) (req *request.Request, output *TestEventPatternOutput)

TestEventPatternRequest generates a request for the TestEventPattern operation.

type DeleteRuleInput 

type DeleteRuleInput struct {

	// The name of the rule to be deleted.
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DeleteRule operation.

func (DeleteRuleInput) GoString 

func (s DeleteRuleInput) GoString() string

GoString returns the string representation

func (DeleteRuleInput) String 

func (s DeleteRuleInput) String() string

String returns the string representation

func (*DeleteRuleInput) Validate 

func (s *DeleteRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRuleOutput 

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

func (DeleteRuleOutput) GoString 

func (s DeleteRuleOutput) GoString() string

GoString returns the string representation

func (DeleteRuleOutput) String 

func (s DeleteRuleOutput) String() string

String returns the string representation

type DescribeRuleInput 

type DescribeRuleInput struct {

	// The name of the rule you want to describe details for.
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DescribeRule operation.

func (DescribeRuleInput) GoString 

func (s DescribeRuleInput) GoString() string

GoString returns the string representation

func (DescribeRuleInput) String 

func (s DescribeRuleInput) String() string

String returns the string representation

func (*DescribeRuleInput) Validate 

func (s *DescribeRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRuleOutput 

type DescribeRuleOutput struct {

	// The Amazon Resource Name (ARN) associated with the rule.
	Arn *string `min:"1" type:"string"`

	// The rule's description.
	Description *string `type:"string"`

	// The event pattern.
	EventPattern *string `type:"string"`

	// The rule's name.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role associated with the rule.
	RoleArn *string `min:"1" type:"string"`

	// The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
	ScheduleExpression *string `type:"string"`

	// Specifies whether the rule is enabled or disabled.
	State *string `type:"string" enum:"RuleState"`
	// contains filtered or unexported fields
}

The result of the DescribeRule operation.

func (DescribeRuleOutput) GoString 

func (s DescribeRuleOutput) GoString() string

GoString returns the string representation

func (DescribeRuleOutput) String 

func (s DescribeRuleOutput) String() string

String returns the string representation

type DisableRuleInput 

type DisableRuleInput struct {

	// The name of the rule you want to disable.
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the DisableRule operation.

func (DisableRuleInput) GoString 

func (s DisableRuleInput) GoString() string

GoString returns the string representation

func (DisableRuleInput) String 

func (s DisableRuleInput) String() string

String returns the string representation

func (*DisableRuleInput) Validate 

func (s *DisableRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableRuleOutput 

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

func (DisableRuleOutput) GoString 

func (s DisableRuleOutput) GoString() string

GoString returns the string representation

func (DisableRuleOutput) String 

func (s DisableRuleOutput) String() string

String returns the string representation

type EnableRuleInput 

type EnableRuleInput struct {

	// The name of the rule that you want to enable.
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the EnableRule operation.

func (EnableRuleInput) GoString 

func (s EnableRuleInput) GoString() string

GoString returns the string representation

func (EnableRuleInput) String 

func (s EnableRuleInput) String() string

String returns the string representation

func (*EnableRuleInput) Validate 

func (s *EnableRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableRuleOutput 

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

func (EnableRuleOutput) GoString 

func (s EnableRuleOutput) GoString() string

GoString returns the string representation

func (EnableRuleOutput) String 

func (s EnableRuleOutput) String() string

String returns the string representation

type ListRuleNamesByTargetInput 

type ListRuleNamesByTargetInput struct {

	// The maximum number of results to return.
	Limit *int64 `min:"1" type:"integer"`

	// The token returned by a previous call to indicate that there is more data
	// available.
	NextToken *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the target resource that you want to list
	// the rules for.
	TargetArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the ListRuleNamesByTarget operation.

func (ListRuleNamesByTargetInput) GoString 

func (s ListRuleNamesByTargetInput) GoString() string

GoString returns the string representation

func (ListRuleNamesByTargetInput) String 

func (s ListRuleNamesByTargetInput) String() string

String returns the string representation

func (*ListRuleNamesByTargetInput) Validate 

func (s *ListRuleNamesByTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRuleNamesByTargetOutput 

type ListRuleNamesByTargetOutput struct {

	// Indicates that there are additional results to retrieve.
	NextToken *string `min:"1" type:"string"`

	// List of rules names that can invoke the given target.
	RuleNames []*string `type:"list"`
	// contains filtered or unexported fields
}

The result of the ListRuleNamesByTarget operation.

func (ListRuleNamesByTargetOutput) GoString 

func (s ListRuleNamesByTargetOutput) GoString() string

GoString returns the string representation

func (ListRuleNamesByTargetOutput) String 

func (s ListRuleNamesByTargetOutput) String() string

String returns the string representation

type ListRulesInput 

type ListRulesInput struct {

	// The maximum number of results to return.
	Limit *int64 `min:"1" type:"integer"`

	// The prefix matching the rule name.
	NamePrefix *string `min:"1" type:"string"`

	// The token returned by a previous call to indicate that there is more data
	// available.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Container for the parameters to the ListRules operation.

func (ListRulesInput) GoString 

func (s ListRulesInput) GoString() string

GoString returns the string representation

func (ListRulesInput) String 

func (s ListRulesInput) String() string

String returns the string representation

func (*ListRulesInput) Validate 

func (s *ListRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRulesOutput 

type ListRulesOutput struct {

	// Indicates that there are additional results to retrieve.
	NextToken *string `min:"1" type:"string"`

	// List of rules matching the specified criteria.
	Rules []*Rule `type:"list"`
	// contains filtered or unexported fields
}

The result of the ListRules operation.

func (ListRulesOutput) GoString 

func (s ListRulesOutput) GoString() string

GoString returns the string representation

func (ListRulesOutput) String 

func (s ListRulesOutput) String() string

String returns the string representation

type ListTargetsByRuleInput 

type ListTargetsByRuleInput struct {

	// The maximum number of results to return.
	Limit *int64 `min:"1" type:"integer"`

	// The token returned by a previous call to indicate that there is more data
	// available.
	NextToken *string `min:"1" type:"string"`

	// The name of the rule whose targets you want to list.
	Rule *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the ListTargetsByRule operation.

func (ListTargetsByRuleInput) GoString 

func (s ListTargetsByRuleInput) GoString() string

GoString returns the string representation

func (ListTargetsByRuleInput) String 

func (s ListTargetsByRuleInput) String() string

String returns the string representation

func (*ListTargetsByRuleInput) Validate 

func (s *ListTargetsByRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTargetsByRuleOutput 

type ListTargetsByRuleOutput struct {

	// Indicates that there are additional results to retrieve.
	NextToken *string `min:"1" type:"string"`

	// Lists the targets assigned to the rule.
	Targets []*Target `type:"list"`
	// contains filtered or unexported fields
}

The result of the ListTargetsByRule operation.

func (ListTargetsByRuleOutput) GoString 

func (s ListTargetsByRuleOutput) GoString() string

GoString returns the string representation

func (ListTargetsByRuleOutput) String 

func (s ListTargetsByRuleOutput) String() string

String returns the string representation

type PutEventsInput 

type PutEventsInput struct {

	// The entry that defines an event in your system. You can specify several parameters
	// for the entry such as the source and type of the event, resources associated
	// with the event, and so on.
	Entries []*PutEventsRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the PutEvents operation.

func (PutEventsInput) GoString 

func (s PutEventsInput) GoString() string

GoString returns the string representation

func (PutEventsInput) String 

func (s PutEventsInput) String() string

String returns the string representation

func (*PutEventsInput) Validate 

func (s *PutEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEventsOutput 

type PutEventsOutput struct {

	// A list of successfully and unsuccessfully ingested events results. If the
	// ingestion was successful, the entry will have the event ID in it. If not,
	// then the ErrorCode and ErrorMessage can be used to identify the problem with
	// the entry.
	Entries []*PutEventsResultEntry `type:"list"`

	// The number of failed entries.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The result of the PutEvents operation.

func (PutEventsOutput) GoString 

func (s PutEventsOutput) GoString() string

GoString returns the string representation

func (PutEventsOutput) String 

func (s PutEventsOutput) String() string

String returns the string representation

type PutEventsRequestEntry 

type PutEventsRequestEntry struct {

	// In the JSON sense, an object containing fields, which may also contain nested
	// sub-objects. No constraints are imposed on its contents.
	Detail *string `type:"string"`

	// Free-form string used to decide what fields to expect in the event detail.
	DetailType *string `type:"string"`

	// AWS resources, identified by Amazon Resource Name (ARN), which the event
	// primarily concerns. Any number, including zero, may be present.
	Resources []*string `type:"list"`

	// The source of the event.
	Source *string `type:"string"`

	// Timestamp of event, per RFC3339 (https://www.rfc-editor.org/rfc/rfc3339.txt).
	// If no timestamp is provided, the timestamp of the PutEvents call will be
	// used.
	Time *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Contains information about the event to be used in PutEvents.

func (PutEventsRequestEntry) GoString 

func (s PutEventsRequestEntry) GoString() string

GoString returns the string representation

func (PutEventsRequestEntry) String 

func (s PutEventsRequestEntry) String() string

String returns the string representation

type PutEventsResultEntry 

type PutEventsResultEntry struct {

	// The error code representing why the event submission failed on this entry.
	ErrorCode *string `type:"string"`

	// The error message explaining why the event submission failed on this entry.
	ErrorMessage *string `type:"string"`

	// The ID of the event submitted to Amazon CloudWatch Events.
	EventId *string `type:"string"`
	// contains filtered or unexported fields
}

A PutEventsResult contains a list of PutEventsResultEntry.

func (PutEventsResultEntry) GoString 

func (s PutEventsResultEntry) GoString() string

GoString returns the string representation

func (PutEventsResultEntry) String 

func (s PutEventsResultEntry) String() string

String returns the string representation

type PutRuleInput 

type PutRuleInput struct {

	// A description of the rule.
	Description *string `type:"string"`

	// The event pattern.
	EventPattern *string `type:"string"`

	// The name of the rule that you are creating or updating.
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role associated with the rule.
	RoleArn *string `min:"1" type:"string"`

	// The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
	ScheduleExpression *string `type:"string"`

	// Indicates whether the rule is enabled or disabled.
	State *string `type:"string" enum:"RuleState"`
	// contains filtered or unexported fields
}

Container for the parameters to the PutRule operation.

func (PutRuleInput) GoString 

func (s PutRuleInput) GoString() string

GoString returns the string representation

func (PutRuleInput) String 

func (s PutRuleInput) String() string

String returns the string representation

func (*PutRuleInput) Validate 

func (s *PutRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutRuleOutput 

type PutRuleOutput struct {

	// The Amazon Resource Name (ARN) that identifies the rule.
	RuleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The result of the PutRule operation.

func (PutRuleOutput) GoString 

func (s PutRuleOutput) GoString() string

GoString returns the string representation

func (PutRuleOutput) String 

func (s PutRuleOutput) String() string

String returns the string representation

type PutTargetsInput 

type PutTargetsInput struct {

	// The name of the rule you want to add targets to.
	Rule *string `min:"1" type:"string" required:"true"`

	// List of targets you want to update or add to the rule.
	Targets []*Target `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the PutTargets operation.

func (PutTargetsInput) GoString 

func (s PutTargetsInput) GoString() string

GoString returns the string representation

func (PutTargetsInput) String 

func (s PutTargetsInput) String() string

String returns the string representation

func (*PutTargetsInput) Validate 

func (s *PutTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutTargetsOutput 

type PutTargetsOutput struct {

	// An array of failed target entries.
	FailedEntries []*PutTargetsResultEntry `type:"list"`

	// The number of failed entries.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The result of the PutTargets operation.

func (PutTargetsOutput) GoString 

func (s PutTargetsOutput) GoString() string

GoString returns the string representation

func (PutTargetsOutput) String 

func (s PutTargetsOutput) String() string

String returns the string representation

type PutTargetsResultEntry 

type PutTargetsResultEntry struct {

	// The error code representing why the target submission failed on this entry.
	ErrorCode *string `type:"string"`

	// The error message explaining why the target submission failed on this entry.
	ErrorMessage *string `type:"string"`

	// The ID of the target submitted to Amazon CloudWatch Events.
	TargetId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A PutTargetsResult contains a list of PutTargetsResultEntry.

func (PutTargetsResultEntry) GoString 

func (s PutTargetsResultEntry) GoString() string

GoString returns the string representation

func (PutTargetsResultEntry) String 

func (s PutTargetsResultEntry) String() string

String returns the string representation

type RemoveTargetsInput 

type RemoveTargetsInput struct {

	// The list of target IDs to remove from the rule.
	Ids []*string `min:"1" type:"list" required:"true"`

	// The name of the rule you want to remove targets from.
	Rule *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the RemoveTargets operation.

func (RemoveTargetsInput) GoString 

func (s RemoveTargetsInput) GoString() string

GoString returns the string representation

func (RemoveTargetsInput) String 

func (s RemoveTargetsInput) String() string

String returns the string representation

func (*RemoveTargetsInput) Validate 

func (s *RemoveTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTargetsOutput 

type RemoveTargetsOutput struct {

	// An array of failed target entries.
	FailedEntries []*RemoveTargetsResultEntry `type:"list"`

	// The number of failed entries.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The result of the RemoveTargets operation.

func (RemoveTargetsOutput) GoString 

func (s RemoveTargetsOutput) GoString() string

GoString returns the string representation

func (RemoveTargetsOutput) String 

func (s RemoveTargetsOutput) String() string

String returns the string representation

type RemoveTargetsResultEntry 

type RemoveTargetsResultEntry struct {

	// The error code representing why the target removal failed on this entry.
	ErrorCode *string `type:"string"`

	// The error message explaining why the target removal failed on this entry.
	ErrorMessage *string `type:"string"`

	// The ID of the target requested to be removed by Amazon CloudWatch Events.
	TargetId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The ID of the target requested to be removed from the rule by Amazon CloudWatch Events.

func (RemoveTargetsResultEntry) GoString 

func (s RemoveTargetsResultEntry) GoString() string

GoString returns the string representation

func (RemoveTargetsResultEntry) String 

func (s RemoveTargetsResultEntry) String() string

String returns the string representation

type Rule 

type Rule struct {

	// The Amazon Resource Name (ARN) of the rule.
	Arn *string `min:"1" type:"string"`

	// The description of the rule.
	Description *string `type:"string"`

	// The event pattern of the rule.
	EventPattern *string `type:"string"`

	// The rule's name.
	Name *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) associated with the role that is used for
	// target invocation.
	RoleArn *string `min:"1" type:"string"`

	// The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
	ScheduleExpression *string `type:"string"`

	// The rule's state.
	State *string `type:"string" enum:"RuleState"`
	// contains filtered or unexported fields
}

Contains information about a rule in Amazon CloudWatch Events. A ListRulesResult contains a list of Rules.

func (Rule) GoString 

func (s Rule) GoString() string

GoString returns the string representation

func (Rule) String 

func (s Rule) String() string

String returns the string representation

type Target 

type Target struct {

	// The Amazon Resource Name (ARN) associated of the target.
	Arn *string `min:"1" type:"string" required:"true"`

	// The unique target assignment ID.
	Id *string `min:"1" type:"string" required:"true"`

	// Valid JSON text passed to the target. For more information about JSON text,
	// see The JavaScript Object Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt).
	Input *string `type:"string"`

	// The value of the JSONPath that is used for extracting part of the matched
	// event when passing it to the target. For more information about JSON paths,
	// see JSONPath (http://goessner.net/articles/JsonPath/).
	InputPath *string `type:"string"`
	// contains filtered or unexported fields
}

Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target: 

Neither Input nor InputPath is specified, then the entire event is passed

to the target in JSON form. InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed). 

Input is specified in the form of a valid JSON, then the matched event

is overridden with this constant.

func (Target) GoString 

func (s Target) GoString() string

GoString returns the string representation

func (Target) String 

func (s Target) String() string

String returns the string representation

func (*Target) Validate 

func (s *Target) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestEventPatternInput 

type TestEventPatternInput struct {

	// The event in the JSON format to test against the event pattern.
	Event *string `type:"string" required:"true"`

	// The event pattern you want to test.
	EventPattern *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Container for the parameters to the TestEventPattern operation.

func (TestEventPatternInput) GoString 

func (s TestEventPatternInput) GoString() string

GoString returns the string representation

func (TestEventPatternInput) String 

func (s TestEventPatternInput) String() string

String returns the string representation

func (*TestEventPatternInput) Validate 

func (s *TestEventPatternInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestEventPatternOutput 

type TestEventPatternOutput struct {

	// Indicates whether the event matches the event pattern.
	Result *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The result of the TestEventPattern operation.

func (TestEventPatternOutput) GoString 

func (s TestEventPatternOutput) GoString() string

GoString returns the string representation

func (TestEventPatternOutput) String 

func (s TestEventPatternOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package cloudwatcheventsiface provides an interface for the Amazon CloudWatch Events.
 Package cloudwatcheventsiface provides an interface for the Amazon CloudWatch Events.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.