cloudwatchevents

package
v1.99.0 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package cloudwatchevents provides the client and types for making API requests to Amazon CloudWatch Events.

Amazon EventBridge 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 predetermined 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 AWS CloudTrail to an Amazon Kinesis data 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 EventBridge, see the Amazon EventBridge User Guide (https://docs.aws.amazon.com/eventbridge/latest/userguide/).

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 contact Amazon CloudWatch Events with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon CloudWatch Events client CloudWatchEvents for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchevents/#New

Index

Constants

View Source 
const (
	// AssignPublicIpEnabled is a AssignPublicIp enum value
	AssignPublicIpEnabled = "ENABLED"

	// AssignPublicIpDisabled is a AssignPublicIp enum value
	AssignPublicIpDisabled = "DISABLED"
)
View Source 
const (
	// EventSourceStatePending is a EventSourceState enum value
	EventSourceStatePending = "PENDING"

	// EventSourceStateActive is a EventSourceState enum value
	EventSourceStateActive = "ACTIVE"

	// EventSourceStateDeleted is a EventSourceState enum value
	EventSourceStateDeleted = "DELETED"
)
View Source 
const (
	// LaunchTypeEc2 is a LaunchType enum value
	LaunchTypeEc2 = "EC2"

	// LaunchTypeFargate is a LaunchType enum value
	LaunchTypeFargate = "FARGATE"
)
View Source 
const (
	// RuleStateEnabled is a RuleState enum value
	RuleStateEnabled = "ENABLED"

	// RuleStateDisabled is a RuleState enum value
	RuleStateDisabled = "DISABLED"
)
View Source 
const (

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// There is concurrent modification on a resource.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// This exception occurs due to unexpected causes.
	ErrCodeInternalException = "InternalException"

	// ErrCodeInvalidEventPatternException for service response error code
	// "InvalidEventPatternException".
	//
	// The event pattern isn't valid.
	ErrCodeInvalidEventPatternException = "InvalidEventPatternException"

	// ErrCodeInvalidStateException for service response error code
	// "InvalidStateException".
	//
	// The specified state isn't a valid state for an event source.
	ErrCodeInvalidStateException = "InvalidStateException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You tried to create more resources than is allowed.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeManagedRuleException for service response error code
	// "ManagedRuleException".
	//
	// An AWS service created this rule on behalf of your account. That service
	// manages it. If you see this error in response to DeleteRule or RemoveTargets,
	// you can use the Force parameter in those calls to delete the rule or remove
	// targets from the rule. You can't modify these managed rules by using DisableRule,
	// EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
	ErrCodeManagedRuleException = "ManagedRuleException"

	// ErrCodePolicyLengthExceededException for service response error code
	// "PolicyLengthExceededException".
	//
	// The event bus policy is too long. For more information, see the limits.
	ErrCodePolicyLengthExceededException = "PolicyLengthExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The resource that you're trying to create already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// An entity that you specified doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
View Source 
const (
	ServiceName = "events"            // Name of service.
	EndpointsID = ServiceName         // ID to lookup a service endpoint with.
	ServiceID   = "CloudWatch Events" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateEventSourceInput added in v1.99.0 

type ActivateEventSourceInput struct {

	// The name of the partner event source to activate.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ActivateEventSourceInput) GoString added in v1.99.0 

func (s ActivateEventSourceInput) GoString() string

GoString returns the string representation

func (*ActivateEventSourceInput) SetName added in v1.99.0 

func (s *ActivateEventSourceInput) SetName(v string) *ActivateEventSourceInput

SetName sets the Name field's value.

func (ActivateEventSourceInput) String added in v1.99.0 

func (s ActivateEventSourceInput) String() string

String returns the string representation

func (*ActivateEventSourceInput) Validate added in v1.99.0 

func (s *ActivateEventSourceInput) Validate() error

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

type ActivateEventSourceOutput added in v1.99.0 

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

func (ActivateEventSourceOutput) GoString added in v1.99.0 

func (s ActivateEventSourceOutput) GoString() string

GoString returns the string representation

func (ActivateEventSourceOutput) String added in v1.99.0 

func (s ActivateEventSourceOutput) String() string

String returns the string representation

type AwsVpcConfiguration added in v1.99.0 

type AwsVpcConfiguration struct {

	// Specifies whether the task's elastic network interface receives a public
	// IP address. You can specify ENABLED only when LaunchType in EcsParameters
	// is set to FARGATE.
	AssignPublicIp *string `type:"string" enum:"AssignPublicIp"`

	// Specifies the security groups associated with the task. These security groups
	// must all be in the same VPC. You can specify as many as five security groups.
	// If you don't specify a security group, the default security group for the
	// VPC is used.
	SecurityGroups []*string `type:"list"`

	// Specifies the subnets associated with the task. These subnets must all be
	// in the same VPC. You can specify as many as 16 subnets.
	//
	// Subnets is a required field
	Subnets []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

This structure specifies the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

func (AwsVpcConfiguration) GoString added in v1.99.0 

func (s AwsVpcConfiguration) GoString() string

GoString returns the string representation

func (*AwsVpcConfiguration) SetAssignPublicIp added in v1.99.0 

func (s *AwsVpcConfiguration) SetAssignPublicIp(v string) *AwsVpcConfiguration

SetAssignPublicIp sets the AssignPublicIp field's value.

func (*AwsVpcConfiguration) SetSecurityGroups added in v1.99.0 

func (s *AwsVpcConfiguration) SetSecurityGroups(v []*string) *AwsVpcConfiguration

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsVpcConfiguration) SetSubnets added in v1.99.0 

func (s *AwsVpcConfiguration) SetSubnets(v []*string) *AwsVpcConfiguration

SetSubnets sets the Subnets field's value.

func (AwsVpcConfiguration) String added in v1.99.0 

func (s AwsVpcConfiguration) String() string

String returns the string representation

func (*AwsVpcConfiguration) Validate added in v1.99.0 

func (s *AwsVpcConfiguration) Validate() error

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

type BatchArrayProperties added in v1.13.8 

type BatchArrayProperties struct {

	// The size of the array, if this is an array batch job. Valid values are integers
	// between 2 and 10,000.
	Size *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

func (BatchArrayProperties) GoString added in v1.13.8 

func (s BatchArrayProperties) GoString() string

GoString returns the string representation

func (*BatchArrayProperties) SetSize added in v1.13.8 

func (s *BatchArrayProperties) SetSize(v int64) *BatchArrayProperties

SetSize sets the Size field's value.

func (BatchArrayProperties) String added in v1.13.8 

func (s BatchArrayProperties) String() string

String returns the string representation

type BatchParameters added in v1.13.8 

type BatchParameters struct {

	// The array properties for the submitted job, such as the size of the array.
	// The array size can be between 2 and 10,000. If you specify array properties
	// for a job, it becomes an array job. This parameter is used only if the target
	// is an AWS Batch job.
	ArrayProperties *BatchArrayProperties `type:"structure"`

	// The ARN or name of the job definition to use if the event target is an AWS
	// Batch job. This job definition must already exist.
	//
	// JobDefinition is a required field
	JobDefinition *string `type:"string" required:"true"`

	// The name to use for this execution of the job, if the target is an AWS Batch
	// job.
	//
	// JobName is a required field
	JobName *string `type:"string" required:"true"`

	// The retry strategy to use for failed jobs if the target is an AWS Batch job.
	// The retry strategy is the number of times to retry the failed job execution.
	// Valid values are 1–10. When you specify a retry strategy here, it overrides
	// the retry strategy defined in the job definition.
	RetryStrategy *BatchRetryStrategy `type:"structure"`
	// contains filtered or unexported fields
}

The custom parameters to be used when the target is an AWS Batch job.

func (BatchParameters) GoString added in v1.13.8 

func (s BatchParameters) GoString() string

GoString returns the string representation

func (*BatchParameters) SetArrayProperties added in v1.13.8 

func (s *BatchParameters) SetArrayProperties(v *BatchArrayProperties) *BatchParameters

SetArrayProperties sets the ArrayProperties field's value.

func (*BatchParameters) SetJobDefinition added in v1.13.8 

func (s *BatchParameters) SetJobDefinition(v string) *BatchParameters

SetJobDefinition sets the JobDefinition field's value.

func (*BatchParameters) SetJobName added in v1.13.8 

func (s *BatchParameters) SetJobName(v string) *BatchParameters

SetJobName sets the JobName field's value.

func (*BatchParameters) SetRetryStrategy added in v1.13.8 

func (s *BatchParameters) SetRetryStrategy(v *BatchRetryStrategy) *BatchParameters

SetRetryStrategy sets the RetryStrategy field's value.

func (BatchParameters) String added in v1.13.8 

func (s BatchParameters) String() string

String returns the string representation

func (*BatchParameters) Validate added in v1.13.8 

func (s *BatchParameters) Validate() error

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

type BatchRetryStrategy added in v1.13.8 

type BatchRetryStrategy struct {

	// The number of times to attempt to retry, if the job fails. Valid values are
	// 1–10.
	Attempts *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The retry strategy to use for failed jobs if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

func (BatchRetryStrategy) GoString added in v1.13.8 

func (s BatchRetryStrategy) GoString() string

GoString returns the string representation

func (*BatchRetryStrategy) SetAttempts added in v1.13.8 

func (s *BatchRetryStrategy) SetAttempts(v int64) *BatchRetryStrategy

SetAttempts sets the Attempts field's value.

func (BatchRetryStrategy) String added in v1.13.8 

func (s BatchRetryStrategy) String() string

String returns the string representation

type CloudWatchEvents 

type CloudWatchEvents struct {
	*client.Client
}

CloudWatchEvents provides the API operation methods for making requests to Amazon CloudWatch Events. See this package's package overview docs for details on the service.

CloudWatchEvents methods are safe to use concurrently. It is not safe to modify mutate any of the struct'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) ActivateEventSource added in v1.99.0 

func (c *CloudWatchEvents) ActivateEventSource(input *ActivateEventSourceInput) (*ActivateEventSourceOutput, error)

ActivateEventSource API operation for Amazon CloudWatch Events.

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

This operation is performed by AWS customers, not by SaaS partners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ActivateEventSource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInvalidStateException "InvalidStateException" The specified state isn't a valid state for an event source.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ActivateEventSource

func (*CloudWatchEvents) ActivateEventSourceRequest added in v1.99.0 

func (c *CloudWatchEvents) ActivateEventSourceRequest(input *ActivateEventSourceInput) (req *request.Request, output *ActivateEventSourceOutput)

ActivateEventSourceRequest generates a "aws/request.Request" representing the client's request for the ActivateEventSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ActivateEventSource for more information on using the ActivateEventSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ActivateEventSourceRequest method.
req, resp := client.ActivateEventSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ActivateEventSource

func (*CloudWatchEvents) ActivateEventSourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) ActivateEventSourceWithContext(ctx aws.Context, input *ActivateEventSourceInput, opts ...request.Option) (*ActivateEventSourceOutput, error)

ActivateEventSourceWithContext is the same as ActivateEventSource with the addition of the ability to pass a context and additional request options.

See ActivateEventSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) CreateEventBus added in v1.99.0 

func (c *CloudWatchEvents) CreateEventBus(input *CreateEventBusInput) (*CreateEventBusOutput, error)

CreateEventBus API operation for Amazon CloudWatch Events.

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your own custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

This operation is used by AWS customers, not by SaaS partners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation CreateEventBus for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource that you're trying to create already exists.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInvalidStateException "InvalidStateException" The specified state isn't a valid state for an event source.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeLimitExceededException "LimitExceededException" You tried to create more resources than is allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBus

func (*CloudWatchEvents) CreateEventBusRequest added in v1.99.0 

func (c *CloudWatchEvents) CreateEventBusRequest(input *CreateEventBusInput) (req *request.Request, output *CreateEventBusOutput)

CreateEventBusRequest generates a "aws/request.Request" representing the client's request for the CreateEventBus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEventBus for more information on using the CreateEventBus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateEventBusRequest method.
req, resp := client.CreateEventBusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreateEventBus

func (*CloudWatchEvents) CreateEventBusWithContext added in v1.99.0 

func (c *CloudWatchEvents) CreateEventBusWithContext(ctx aws.Context, input *CreateEventBusInput, opts ...request.Option) (*CreateEventBusOutput, error)

CreateEventBusWithContext is the same as CreateEventBus with the addition of the ability to pass a context and additional request options.

See CreateEventBus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) CreatePartnerEventSource added in v1.99.0 

func (c *CloudWatchEvents) CreatePartnerEventSource(input *CreatePartnerEventSourceInput) (*CreatePartnerEventSourceOutput, error)

CreatePartnerEventSource API operation for Amazon CloudWatch Events.

Called by an SaaS partner to create a partner event source.

This operation is not used by AWS customers.

Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types.

A partner event source creates events based on resources in the SaaS partner's service or application.

An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets.

Partner event source names follow this format:

aws.partner/partner_name/event_namespace/event_name

  • partner_name is determined during partner registration and identifies the partner to AWS customers.

  • For event_namespace, we recommend that partners use a string that identifies the AWS customer within the partner's system. This should not be the customer's AWS account ID.

  • event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. This should help AWS customers decide whether to create an event bus to receive these events.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation CreatePartnerEventSource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException" The resource that you're trying to create already exists.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeLimitExceededException "LimitExceededException" You tried to create more resources than is allowed.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSource

func (*CloudWatchEvents) CreatePartnerEventSourceRequest added in v1.99.0 

func (c *CloudWatchEvents) CreatePartnerEventSourceRequest(input *CreatePartnerEventSourceInput) (req *request.Request, output *CreatePartnerEventSourceOutput)

CreatePartnerEventSourceRequest generates a "aws/request.Request" representing the client's request for the CreatePartnerEventSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePartnerEventSource for more information on using the CreatePartnerEventSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreatePartnerEventSourceRequest method.
req, resp := client.CreatePartnerEventSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/CreatePartnerEventSource

func (*CloudWatchEvents) CreatePartnerEventSourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) CreatePartnerEventSourceWithContext(ctx aws.Context, input *CreatePartnerEventSourceInput, opts ...request.Option) (*CreatePartnerEventSourceOutput, error)

CreatePartnerEventSourceWithContext is the same as CreatePartnerEventSource with the addition of the ability to pass a context and additional request options.

See CreatePartnerEventSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DeactivateEventSource added in v1.99.0 

func (c *CloudWatchEvents) DeactivateEventSource(input *DeactivateEventSourceInput) (*DeactivateEventSourceOutput, error)

DeactivateEventSource API operation for Amazon CloudWatch Events.

An AWS customer uses this operation to temporarily stop receiving events from the specified partner event source. The matching event bus isn't deleted.

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it's deleted.

To activate a deactivated partner event source, use ActivateEventSource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DeactivateEventSource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInvalidStateException "InvalidStateException" The specified state isn't a valid state for an event source.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeactivateEventSource

func (*CloudWatchEvents) DeactivateEventSourceRequest added in v1.99.0 

func (c *CloudWatchEvents) DeactivateEventSourceRequest(input *DeactivateEventSourceInput) (req *request.Request, output *DeactivateEventSourceOutput)

DeactivateEventSourceRequest generates a "aws/request.Request" representing the client's request for the DeactivateEventSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeactivateEventSource for more information on using the DeactivateEventSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeactivateEventSourceRequest method.
req, resp := client.DeactivateEventSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeactivateEventSource

func (*CloudWatchEvents) DeactivateEventSourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) DeactivateEventSourceWithContext(ctx aws.Context, input *DeactivateEventSourceInput, opts ...request.Option) (*DeactivateEventSourceOutput, error)

DeactivateEventSourceWithContext is the same as DeactivateEventSource with the addition of the ability to pass a context and additional request options.

See DeactivateEventSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DeleteEventBus added in v1.99.0 

func (c *CloudWatchEvents) DeleteEventBus(input *DeleteEventBusInput) (*DeleteEventBusOutput, error)

DeleteEventBus API operation for Amazon CloudWatch Events.

Deletes the specified custom event bus or partner event bus. All rules associated with this event bus are also deleted. You can't delete your account's default event bus.

This operation is performed by AWS customers, not by SaaS partners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DeleteEventBus for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteEventBus

func (*CloudWatchEvents) DeleteEventBusRequest added in v1.99.0 

func (c *CloudWatchEvents) DeleteEventBusRequest(input *DeleteEventBusInput) (req *request.Request, output *DeleteEventBusOutput)

DeleteEventBusRequest generates a "aws/request.Request" representing the client's request for the DeleteEventBus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEventBus for more information on using the DeleteEventBus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteEventBusRequest method.
req, resp := client.DeleteEventBusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteEventBus

func (*CloudWatchEvents) DeleteEventBusWithContext added in v1.99.0 

func (c *CloudWatchEvents) DeleteEventBusWithContext(ctx aws.Context, input *DeleteEventBusInput, opts ...request.Option) (*DeleteEventBusOutput, error)

DeleteEventBusWithContext is the same as DeleteEventBus with the addition of the ability to pass a context and additional request options.

See DeleteEventBus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DeletePartnerEventSource added in v1.99.0 

func (c *CloudWatchEvents) DeletePartnerEventSource(input *DeletePartnerEventSourceInput) (*DeletePartnerEventSourceOutput, error)

DeletePartnerEventSource API operation for Amazon CloudWatch Events.

This operation is used by SaaS partners to delete a partner event source. AWS customers don't use this operation.

When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DeletePartnerEventSource for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeletePartnerEventSource

func (*CloudWatchEvents) DeletePartnerEventSourceRequest added in v1.99.0 

func (c *CloudWatchEvents) DeletePartnerEventSourceRequest(input *DeletePartnerEventSourceInput) (req *request.Request, output *DeletePartnerEventSourceOutput)

DeletePartnerEventSourceRequest generates a "aws/request.Request" representing the client's request for the DeletePartnerEventSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePartnerEventSource for more information on using the DeletePartnerEventSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePartnerEventSourceRequest method.
req, resp := client.DeletePartnerEventSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeletePartnerEventSource

func (*CloudWatchEvents) DeletePartnerEventSourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) DeletePartnerEventSourceWithContext(ctx aws.Context, input *DeletePartnerEventSourceInput, opts ...request.Option) (*DeletePartnerEventSourceOutput, error)

DeletePartnerEventSourceWithContext is the same as DeletePartnerEventSource with the addition of the ability to pass a context and additional request options.

See DeletePartnerEventSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DeleteRule 

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

DeleteRule API operation for Amazon CloudWatch Events.

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using RemoveTargets.

When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.

Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you're sure that the other service isn't still using that rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DeleteRule for usage and error information.

Returned Error Codes:

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteRule

func (*CloudWatchEvents) DeleteRuleRequest 

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

DeleteRuleRequest generates a "aws/request.Request" representing the client's request for the DeleteRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRule for more information on using the DeleteRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteRuleRequest method.
req, resp := client.DeleteRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteRule

func (*CloudWatchEvents) DeleteRuleWithContext added in v1.8.0 

func (c *CloudWatchEvents) DeleteRuleWithContext(ctx aws.Context, input *DeleteRuleInput, opts ...request.Option) (*DeleteRuleOutput, error)

DeleteRuleWithContext is the same as DeleteRule with the addition of the ability to pass a context and additional request options.

See DeleteRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DescribeEventBus added in v1.10.5 

func (c *CloudWatchEvents) DescribeEventBus(input *DescribeEventBusInput) (*DescribeEventBusOutput, error)

DescribeEventBus API operation for Amazon CloudWatch Events.

Displays details about an event bus in your account. This can include the external AWS accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

To enable your account to receive events from other accounts on its default event bus, use PutPermission.

For more information about partner event buses, see CreateEventBus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DescribeEventBus for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventBus

func (*CloudWatchEvents) DescribeEventBusRequest added in v1.10.5 

func (c *CloudWatchEvents) DescribeEventBusRequest(input *DescribeEventBusInput) (req *request.Request, output *DescribeEventBusOutput)

DescribeEventBusRequest generates a "aws/request.Request" representing the client's request for the DescribeEventBus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventBus for more information on using the DescribeEventBus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventBusRequest method.
req, resp := client.DescribeEventBusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventBus

func (*CloudWatchEvents) DescribeEventBusWithContext added in v1.10.5 

func (c *CloudWatchEvents) DescribeEventBusWithContext(ctx aws.Context, input *DescribeEventBusInput, opts ...request.Option) (*DescribeEventBusOutput, error)

DescribeEventBusWithContext is the same as DescribeEventBus with the addition of the ability to pass a context and additional request options.

See DescribeEventBus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DescribeEventSource added in v1.99.0 

func (c *CloudWatchEvents) DescribeEventSource(input *DescribeEventSourceInput) (*DescribeEventSourceOutput, error)

DescribeEventSource API operation for Amazon CloudWatch Events.

This operation lists details about a partner event source that is shared with your account.

This operation is run by AWS customers, not by SaaS partners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DescribeEventSource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventSource

func (*CloudWatchEvents) DescribeEventSourceRequest added in v1.99.0 

func (c *CloudWatchEvents) DescribeEventSourceRequest(input *DescribeEventSourceInput) (req *request.Request, output *DescribeEventSourceOutput)

DescribeEventSourceRequest generates a "aws/request.Request" representing the client's request for the DescribeEventSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEventSource for more information on using the DescribeEventSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeEventSourceRequest method.
req, resp := client.DescribeEventSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeEventSource

func (*CloudWatchEvents) DescribeEventSourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) DescribeEventSourceWithContext(ctx aws.Context, input *DescribeEventSourceInput, opts ...request.Option) (*DescribeEventSourceOutput, error)

DescribeEventSourceWithContext is the same as DescribeEventSource with the addition of the ability to pass a context and additional request options.

See DescribeEventSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DescribePartnerEventSource added in v1.99.0 

func (c *CloudWatchEvents) DescribePartnerEventSource(input *DescribePartnerEventSourceInput) (*DescribePartnerEventSourceOutput, error)

DescribePartnerEventSource API operation for Amazon CloudWatch Events.

An SaaS partner can use this operation to list details about a partner event source that they have created.

AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DescribePartnerEventSource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribePartnerEventSource

func (*CloudWatchEvents) DescribePartnerEventSourceRequest added in v1.99.0 

func (c *CloudWatchEvents) DescribePartnerEventSourceRequest(input *DescribePartnerEventSourceInput) (req *request.Request, output *DescribePartnerEventSourceOutput)

DescribePartnerEventSourceRequest generates a "aws/request.Request" representing the client's request for the DescribePartnerEventSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePartnerEventSource for more information on using the DescribePartnerEventSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribePartnerEventSourceRequest method.
req, resp := client.DescribePartnerEventSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribePartnerEventSource

func (*CloudWatchEvents) DescribePartnerEventSourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) DescribePartnerEventSourceWithContext(ctx aws.Context, input *DescribePartnerEventSourceInput, opts ...request.Option) (*DescribePartnerEventSourceOutput, error)

DescribePartnerEventSourceWithContext is the same as DescribePartnerEventSource with the addition of the ability to pass a context and additional request options.

See DescribePartnerEventSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DescribeRule 

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

DescribeRule API operation for Amazon CloudWatch Events.

Describes the specified rule.

DescribeRule doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DescribeRule for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRule

func (*CloudWatchEvents) DescribeRuleRequest 

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

DescribeRuleRequest generates a "aws/request.Request" representing the client's request for the DescribeRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRule for more information on using the DescribeRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeRuleRequest method.
req, resp := client.DescribeRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRule

func (*CloudWatchEvents) DescribeRuleWithContext added in v1.8.0 

func (c *CloudWatchEvents) DescribeRuleWithContext(ctx aws.Context, input *DescribeRuleInput, opts ...request.Option) (*DescribeRuleOutput, error)

DescribeRuleWithContext is the same as DescribeRule with the addition of the ability to pass a context and additional request options.

See DescribeRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) DisableRule 

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

DisableRule API operation for Amazon CloudWatch Events.

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

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation DisableRule for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule

func (*CloudWatchEvents) DisableRuleRequest 

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

DisableRuleRequest generates a "aws/request.Request" representing the client's request for the DisableRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableRule for more information on using the DisableRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisableRuleRequest method.
req, resp := client.DisableRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule

func (*CloudWatchEvents) DisableRuleWithContext added in v1.8.0 

func (c *CloudWatchEvents) DisableRuleWithContext(ctx aws.Context, input *DisableRuleInput, opts ...request.Option) (*DisableRuleOutput, error)

DisableRuleWithContext is the same as DisableRule with the addition of the ability to pass a context and additional request options.

See DisableRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) EnableRule 

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

EnableRule API operation for Amazon CloudWatch Events.

Enables the specified rule. If the rule doesn't exist, the operation fails.

When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation EnableRule for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule

func (*CloudWatchEvents) EnableRuleRequest 

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

EnableRuleRequest generates a "aws/request.Request" representing the client's request for the EnableRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableRule for more information on using the EnableRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the EnableRuleRequest method.
req, resp := client.EnableRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule

func (*CloudWatchEvents) EnableRuleWithContext added in v1.8.0 

func (c *CloudWatchEvents) EnableRuleWithContext(ctx aws.Context, input *EnableRuleInput, opts ...request.Option) (*EnableRuleOutput, error)

EnableRuleWithContext is the same as EnableRule with the addition of the ability to pass a context and additional request options.

See EnableRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListEventBuses added in v1.99.0 

func (c *CloudWatchEvents) ListEventBuses(input *ListEventBusesInput) (*ListEventBusesOutput, error)

ListEventBuses API operation for Amazon CloudWatch Events.

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

This operation is run by AWS customers, not by SaaS partners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListEventBuses for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventBuses

func (*CloudWatchEvents) ListEventBusesRequest added in v1.99.0 

func (c *CloudWatchEvents) ListEventBusesRequest(input *ListEventBusesInput) (req *request.Request, output *ListEventBusesOutput)

ListEventBusesRequest generates a "aws/request.Request" representing the client's request for the ListEventBuses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEventBuses for more information on using the ListEventBuses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEventBusesRequest method.
req, resp := client.ListEventBusesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventBuses

func (*CloudWatchEvents) ListEventBusesWithContext added in v1.99.0 

func (c *CloudWatchEvents) ListEventBusesWithContext(ctx aws.Context, input *ListEventBusesInput, opts ...request.Option) (*ListEventBusesOutput, error)

ListEventBusesWithContext is the same as ListEventBuses with the addition of the ability to pass a context and additional request options.

See ListEventBuses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListEventSources added in v1.99.0 

func (c *CloudWatchEvents) ListEventSources(input *ListEventSourcesInput) (*ListEventSourcesOutput, error)

ListEventSources API operation for Amazon CloudWatch Events.

You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.

This operation is run by AWS customers, not by SaaS partners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListEventSources for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventSources

func (*CloudWatchEvents) ListEventSourcesRequest added in v1.99.0 

func (c *CloudWatchEvents) ListEventSourcesRequest(input *ListEventSourcesInput) (req *request.Request, output *ListEventSourcesOutput)

ListEventSourcesRequest generates a "aws/request.Request" representing the client's request for the ListEventSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEventSources for more information on using the ListEventSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListEventSourcesRequest method.
req, resp := client.ListEventSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListEventSources

func (*CloudWatchEvents) ListEventSourcesWithContext added in v1.99.0 

func (c *CloudWatchEvents) ListEventSourcesWithContext(ctx aws.Context, input *ListEventSourcesInput, opts ...request.Option) (*ListEventSourcesOutput, error)

ListEventSourcesWithContext is the same as ListEventSources with the addition of the ability to pass a context and additional request options.

See ListEventSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListPartnerEventSourceAccounts added in v1.99.0 

func (c *CloudWatchEvents) ListPartnerEventSourceAccounts(input *ListPartnerEventSourceAccountsInput) (*ListPartnerEventSourceAccountsOutput, error)

ListPartnerEventSourceAccounts API operation for Amazon CloudWatch Events.

An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with.

This operation is used by SaaS partners, not by AWS customers.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListPartnerEventSourceAccounts for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSourceAccounts

func (*CloudWatchEvents) ListPartnerEventSourceAccountsRequest added in v1.99.0 

func (c *CloudWatchEvents) ListPartnerEventSourceAccountsRequest(input *ListPartnerEventSourceAccountsInput) (req *request.Request, output *ListPartnerEventSourceAccountsOutput)

ListPartnerEventSourceAccountsRequest generates a "aws/request.Request" representing the client's request for the ListPartnerEventSourceAccounts operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPartnerEventSourceAccounts for more information on using the ListPartnerEventSourceAccounts API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPartnerEventSourceAccountsRequest method.
req, resp := client.ListPartnerEventSourceAccountsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSourceAccounts

func (*CloudWatchEvents) ListPartnerEventSourceAccountsWithContext added in v1.99.0 

func (c *CloudWatchEvents) ListPartnerEventSourceAccountsWithContext(ctx aws.Context, input *ListPartnerEventSourceAccountsInput, opts ...request.Option) (*ListPartnerEventSourceAccountsOutput, error)

ListPartnerEventSourceAccountsWithContext is the same as ListPartnerEventSourceAccounts with the addition of the ability to pass a context and additional request options.

See ListPartnerEventSourceAccounts for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListPartnerEventSources added in v1.99.0 

func (c *CloudWatchEvents) ListPartnerEventSources(input *ListPartnerEventSourcesInput) (*ListPartnerEventSourcesOutput, error)

ListPartnerEventSources API operation for Amazon CloudWatch Events.

An SaaS partner can use this operation to list all the partner event source names that they have created.

This operation is not used by AWS customers.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListPartnerEventSources for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSources

func (*CloudWatchEvents) ListPartnerEventSourcesRequest added in v1.99.0 

func (c *CloudWatchEvents) ListPartnerEventSourcesRequest(input *ListPartnerEventSourcesInput) (req *request.Request, output *ListPartnerEventSourcesOutput)

ListPartnerEventSourcesRequest generates a "aws/request.Request" representing the client's request for the ListPartnerEventSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPartnerEventSources for more information on using the ListPartnerEventSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPartnerEventSourcesRequest method.
req, resp := client.ListPartnerEventSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListPartnerEventSources

func (*CloudWatchEvents) ListPartnerEventSourcesWithContext added in v1.99.0 

func (c *CloudWatchEvents) ListPartnerEventSourcesWithContext(ctx aws.Context, input *ListPartnerEventSourcesInput, opts ...request.Option) (*ListPartnerEventSourcesOutput, error)

ListPartnerEventSourcesWithContext is the same as ListPartnerEventSources with the addition of the ability to pass a context and additional request options.

See ListPartnerEventSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListRuleNamesByTarget 

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

ListRuleNamesByTarget API operation for Amazon CloudWatch Events.

Lists the rules for the specified target. You can see which rules can invoke a specific target in your account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListRuleNamesByTarget for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRuleNamesByTarget

func (*CloudWatchEvents) ListRuleNamesByTargetRequest 

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

ListRuleNamesByTargetRequest generates a "aws/request.Request" representing the client's request for the ListRuleNamesByTarget operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRuleNamesByTarget for more information on using the ListRuleNamesByTarget API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListRuleNamesByTargetRequest method.
req, resp := client.ListRuleNamesByTargetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRuleNamesByTarget

func (*CloudWatchEvents) ListRuleNamesByTargetWithContext added in v1.8.0 

func (c *CloudWatchEvents) ListRuleNamesByTargetWithContext(ctx aws.Context, input *ListRuleNamesByTargetInput, opts ...request.Option) (*ListRuleNamesByTargetOutput, error)

ListRuleNamesByTargetWithContext is the same as ListRuleNamesByTarget with the addition of the ability to pass a context and additional request options.

See ListRuleNamesByTarget for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListRules 

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

ListRules API operation for Amazon CloudWatch Events.

Lists your EventBridge rules. You can either list all the rules or provide a prefix to match to the rule names.

ListRules doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListRules for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRules

func (*CloudWatchEvents) ListRulesRequest 

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

ListRulesRequest generates a "aws/request.Request" representing the client's request for the ListRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRules for more information on using the ListRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListRulesRequest method.
req, resp := client.ListRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRules

func (*CloudWatchEvents) ListRulesWithContext added in v1.8.0 

func (c *CloudWatchEvents) ListRulesWithContext(ctx aws.Context, input *ListRulesInput, opts ...request.Option) (*ListRulesOutput, error)

ListRulesWithContext is the same as ListRules with the addition of the ability to pass a context and additional request options.

See ListRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListTagsForResource added in v1.99.0 

func (c *CloudWatchEvents) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon CloudWatch Events.

Displays the tags associated with an EventBridge resource. In EventBridge, rules can be tagged.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTagsForResource

func (*CloudWatchEvents) ListTagsForResourceRequest added in v1.99.0 

func (c *CloudWatchEvents) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTagsForResource

func (*CloudWatchEvents) ListTagsForResourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) ListTargetsByRule 

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

ListTargetsByRule API operation for Amazon CloudWatch Events.

Lists the targets assigned to the specified rule.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation ListTargetsByRule for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTargetsByRule

func (*CloudWatchEvents) ListTargetsByRuleRequest 

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

ListTargetsByRuleRequest generates a "aws/request.Request" representing the client's request for the ListTargetsByRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTargetsByRule for more information on using the ListTargetsByRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTargetsByRuleRequest method.
req, resp := client.ListTargetsByRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTargetsByRule

func (*CloudWatchEvents) ListTargetsByRuleWithContext added in v1.8.0 

func (c *CloudWatchEvents) ListTargetsByRuleWithContext(ctx aws.Context, input *ListTargetsByRuleInput, opts ...request.Option) (*ListTargetsByRuleOutput, error)

ListTargetsByRuleWithContext is the same as ListTargetsByRule with the addition of the ability to pass a context and additional request options.

See ListTargetsByRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) PutEvents 

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

PutEvents API operation for Amazon CloudWatch Events.

Sends custom events to EventBridge so that they can be matched to rules. These events can be from your custom applications and services.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation PutEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEvents

func (*CloudWatchEvents) PutEventsRequest 

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

PutEventsRequest generates a "aws/request.Request" representing the client's request for the PutEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutEvents for more information on using the PutEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutEventsRequest method.
req, resp := client.PutEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEvents

func (*CloudWatchEvents) PutEventsWithContext added in v1.8.0 

func (c *CloudWatchEvents) PutEventsWithContext(ctx aws.Context, input *PutEventsInput, opts ...request.Option) (*PutEventsOutput, error)

PutEventsWithContext is the same as PutEvents with the addition of the ability to pass a context and additional request options.

See PutEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) PutPartnerEvents added in v1.99.0 

func (c *CloudWatchEvents) PutPartnerEvents(input *PutPartnerEventsInput) (*PutPartnerEventsOutput, error)

PutPartnerEvents API operation for Amazon CloudWatch Events.

This is used by SaaS partners to write events to a customer's partner event bus.

AWS customers do not use this operation. Instead, AWS customers can use PutEvents to write custom events from their own applications to an event bus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation PutPartnerEvents for usage and error information.

Returned Error Codes:

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEvents

func (*CloudWatchEvents) PutPartnerEventsRequest added in v1.99.0 

func (c *CloudWatchEvents) PutPartnerEventsRequest(input *PutPartnerEventsInput) (req *request.Request, output *PutPartnerEventsOutput)

PutPartnerEventsRequest generates a "aws/request.Request" representing the client's request for the PutPartnerEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPartnerEvents for more information on using the PutPartnerEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutPartnerEventsRequest method.
req, resp := client.PutPartnerEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPartnerEvents

func (*CloudWatchEvents) PutPartnerEventsWithContext added in v1.99.0 

func (c *CloudWatchEvents) PutPartnerEventsWithContext(ctx aws.Context, input *PutPartnerEventsInput, opts ...request.Option) (*PutPartnerEventsOutput, error)

PutPartnerEventsWithContext is the same as PutPartnerEvents with the addition of the ability to pass a context and additional request options.

See PutPartnerEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) PutPermission added in v1.10.5 

func (c *CloudWatchEvents) PutPermission(input *PutPermissionInput) (*PutPermissionOutput, error)

PutPermission API operation for Amazon CloudWatch Events.

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Rules in your account are triggered by these events arriving to an event bus in your account.

For another account to send events to your account, that external account must have a rule with your account's event bus as a target.

To enable multiple AWS accounts to put events to an event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the Amazon EventBridge User Guide.

The permission policy on an event bus can't exceed 10 KB in size.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation PutPermission for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodePolicyLengthExceededException "PolicyLengthExceededException" The event bus policy is too long. For more information, see the limits.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPermission

func (*CloudWatchEvents) PutPermissionRequest added in v1.10.5 

func (c *CloudWatchEvents) PutPermissionRequest(input *PutPermissionInput) (req *request.Request, output *PutPermissionOutput)

PutPermissionRequest generates a "aws/request.Request" representing the client's request for the PutPermission operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutPermission for more information on using the PutPermission API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutPermissionRequest method.
req, resp := client.PutPermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutPermission

func (*CloudWatchEvents) PutPermissionWithContext added in v1.10.5 

func (c *CloudWatchEvents) PutPermissionWithContext(ctx aws.Context, input *PutPermissionInput, opts ...request.Option) (*PutPermissionOutput, error)

PutPermissionWithContext is the same as PutPermission with the addition of the ability to pass a context and additional request options.

See PutPermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) PutRule 

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

PutRule API operation for Amazon CloudWatch Events.

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

A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.

If you're updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments aren't kept. Instead, they're replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. 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 triggers on matching events as well as on a schedule.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge 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 that you want to match.

In EventBridge, you could create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If you don't write the rule carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

To prevent this, write the rules so that the triggered actions don't refire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation PutRule for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidEventPatternException "InvalidEventPatternException" The event pattern isn't valid.

  • ErrCodeLimitExceededException "LimitExceededException" You tried to create more resources than is allowed.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRule

func (*CloudWatchEvents) PutRuleRequest 

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

PutRuleRequest generates a "aws/request.Request" representing the client's request for the PutRule operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutRule for more information on using the PutRule API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutRuleRequest method.
req, resp := client.PutRuleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRule

func (*CloudWatchEvents) PutRuleWithContext added in v1.8.0 

func (c *CloudWatchEvents) PutRuleWithContext(ctx aws.Context, input *PutRuleInput, opts ...request.Option) (*PutRuleOutput, error)

PutRuleWithContext is the same as PutRule with the addition of the ability to pass a context and additional request options.

See PutRule for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) PutTargets 

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

PutTargets API operation for Amazon CloudWatch Events.

Adds the specified targets to the specified rule, or updates the targets if they're already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets in EventBridge:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

Creating rules with built-in targets is supported only on the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control (https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the Amazon EventBridge User Guide.

If another AWS account is in the same Region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event isn't charged. For more information, see Amazon EventBridge Pricing (https://aws.amazon.com/eventbridge/pricing/).

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the Amazon EventBridge User Guide.

For more information about enabling cross-account events, see PutPermission.

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

  • If none of the following arguments are specified for a target, the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, $.detail), only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is nonzero in the response, and each entry in FailedEntries provides the ID of the failed target and the error code.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation PutTargets for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeLimitExceededException "LimitExceededException" You tried to create more resources than is allowed.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutTargets

func (*CloudWatchEvents) PutTargetsRequest 

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

PutTargetsRequest generates a "aws/request.Request" representing the client's request for the PutTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutTargets for more information on using the PutTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutTargetsRequest method.
req, resp := client.PutTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutTargets

func (*CloudWatchEvents) PutTargetsWithContext added in v1.8.0 

func (c *CloudWatchEvents) PutTargetsWithContext(ctx aws.Context, input *PutTargetsInput, opts ...request.Option) (*PutTargetsOutput, error)

PutTargetsWithContext is the same as PutTargets with the addition of the ability to pass a context and additional request options.

See PutTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) RemovePermission added in v1.10.5 

func (c *CloudWatchEvents) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error)

RemovePermission API operation for Amazon CloudWatch Events.

Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation RemovePermission for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemovePermission

func (*CloudWatchEvents) RemovePermissionRequest added in v1.10.5 

func (c *CloudWatchEvents) RemovePermissionRequest(input *RemovePermissionInput) (req *request.Request, output *RemovePermissionOutput)

RemovePermissionRequest generates a "aws/request.Request" representing the client's request for the RemovePermission operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemovePermission for more information on using the RemovePermission API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RemovePermissionRequest method.
req, resp := client.RemovePermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemovePermission

func (*CloudWatchEvents) RemovePermissionWithContext added in v1.10.5 

func (c *CloudWatchEvents) RemovePermissionWithContext(ctx aws.Context, input *RemovePermissionInput, opts ...request.Option) (*RemovePermissionOutput, error)

RemovePermissionWithContext is the same as RemovePermission with the addition of the ability to pass a context and additional request options.

See RemovePermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) RemoveTargets 

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

RemoveTargets API operation for Amazon CloudWatch Events.

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation RemoveTargets for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargets

func (*CloudWatchEvents) RemoveTargetsRequest 

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

RemoveTargetsRequest generates a "aws/request.Request" representing the client's request for the RemoveTargets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveTargets for more information on using the RemoveTargets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RemoveTargetsRequest method.
req, resp := client.RemoveTargetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargets

func (*CloudWatchEvents) RemoveTargetsWithContext added in v1.8.0 

func (c *CloudWatchEvents) RemoveTargetsWithContext(ctx aws.Context, input *RemoveTargetsInput, opts ...request.Option) (*RemoveTargetsOutput, error)

RemoveTargetsWithContext is the same as RemoveTargets with the addition of the ability to pass a context and additional request options.

See RemoveTargets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) TagResource added in v1.99.0 

func (c *CloudWatchEvents) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon CloudWatch Events.

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TagResource

func (*CloudWatchEvents) TagResourceRequest added in v1.99.0 

func (c *CloudWatchEvents) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TagResource

func (*CloudWatchEvents) TagResourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) TestEventPattern 

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

TestEventPattern API operation for Amazon CloudWatch Events.

Tests whether the specified event pattern matches the provided event.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge 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 that you want to match.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation TestEventPattern for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidEventPatternException "InvalidEventPatternException" The event pattern isn't valid.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TestEventPattern

func (*CloudWatchEvents) TestEventPatternRequest 

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

TestEventPatternRequest generates a "aws/request.Request" representing the client's request for the TestEventPattern operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TestEventPattern for more information on using the TestEventPattern API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TestEventPatternRequest method.
req, resp := client.TestEventPatternRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TestEventPattern

func (*CloudWatchEvents) TestEventPatternWithContext added in v1.8.0 

func (c *CloudWatchEvents) TestEventPatternWithContext(ctx aws.Context, input *TestEventPatternInput, opts ...request.Option) (*TestEventPatternOutput, error)

TestEventPatternWithContext is the same as TestEventPattern with the addition of the ability to pass a context and additional request options.

See TestEventPattern for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) UntagResource added in v1.99.0 

func (c *CloudWatchEvents) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon CloudWatch Events.

Removes one or more tags from the specified EventBridge resource. In EventBridge, rules can be tagged.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" An entity that you specified doesn't exist.

  • ErrCodeInternalException "InternalException" This exception occurs due to unexpected causes.

  • ErrCodeConcurrentModificationException "ConcurrentModificationException" There is concurrent modification on a resource.

  • ErrCodeManagedRuleException "ManagedRuleException" An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UntagResource

func (*CloudWatchEvents) UntagResourceRequest added in v1.99.0 

func (c *CloudWatchEvents) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UntagResource

func (*CloudWatchEvents) UntagResourceWithContext added in v1.99.0 

func (c *CloudWatchEvents) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Condition added in v1.99.0 

type Condition struct {

	// The key for the condition. Currently, the only supported key is aws:PrincipalOrgID.
	//
	// Key is a required field
	Key *string `type:"string" required:"true"`

	// The type of condition. Currently, the only supported value is StringEquals.
	//
	// Type is a required field
	Type *string `type:"string" required:"true"`

	// The value for the key. Currently, this must be the ID of the organization.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A JSON string that you can use to limit the event bus permissions that you're granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the AWS organization. The following is an example value for Condition:

'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'

func (Condition) GoString added in v1.99.0 

func (s Condition) GoString() string

GoString returns the string representation

func (*Condition) SetKey added in v1.99.0 

func (s *Condition) SetKey(v string) *Condition

SetKey sets the Key field's value.

func (*Condition) SetType added in v1.99.0 

func (s *Condition) SetType(v string) *Condition

SetType sets the Type field's value.

func (*Condition) SetValue added in v1.99.0 

func (s *Condition) SetValue(v string) *Condition

SetValue sets the Value field's value.

func (Condition) String added in v1.99.0 

func (s Condition) String() string

String returns the string representation

func (*Condition) Validate added in v1.99.0 

func (s *Condition) Validate() error

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

type CreateEventBusInput added in v1.99.0 

type CreateEventBusInput struct {

	// If you're creating a partner event bus, this specifies the partner event
	// source that the new event bus will be matched with.
	EventSourceName *string `min:"1" type:"string"`

	// The name of the new event bus.
	//
	// The names of custom event buses can't contain the / character. You can't
	// use the name default for a custom event bus because this name is already
	// used for your account's default event bus.
	//
	// If this is a partner event bus, the name must exactly match the name of the
	// partner event source that this event bus is matched to. This name will include
	// the / character.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateEventBusInput) GoString added in v1.99.0 

func (s CreateEventBusInput) GoString() string

GoString returns the string representation

func (*CreateEventBusInput) SetEventSourceName added in v1.99.0 

func (s *CreateEventBusInput) SetEventSourceName(v string) *CreateEventBusInput

SetEventSourceName sets the EventSourceName field's value.

func (*CreateEventBusInput) SetName added in v1.99.0 

func (s *CreateEventBusInput) SetName(v string) *CreateEventBusInput

SetName sets the Name field's value.

func (CreateEventBusInput) String added in v1.99.0 

func (s CreateEventBusInput) String() string

String returns the string representation

func (*CreateEventBusInput) Validate added in v1.99.0 

func (s *CreateEventBusInput) Validate() error

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

type CreateEventBusOutput added in v1.99.0 

type CreateEventBusOutput struct {

	// The ARN of the new event bus.
	EventBusArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateEventBusOutput) GoString added in v1.99.0 

func (s CreateEventBusOutput) GoString() string

GoString returns the string representation

func (*CreateEventBusOutput) SetEventBusArn added in v1.99.0 

func (s *CreateEventBusOutput) SetEventBusArn(v string) *CreateEventBusOutput

SetEventBusArn sets the EventBusArn field's value.

func (CreateEventBusOutput) String added in v1.99.0 

func (s CreateEventBusOutput) String() string

String returns the string representation

type CreatePartnerEventSourceInput added in v1.99.0 

type CreatePartnerEventSourceInput struct {

	// The AWS account ID of the customer who is permitted to create a matching
	// partner event bus for this partner event source.
	//
	// Account is a required field
	Account *string `min:"12" type:"string" required:"true"`

	// The name of the partner event source. This name must be unique and must be
	// in the format partner_name/event_namespace/event_name . The AWS account that
	// wants to use this partner event source must create a partner event bus with
	// a name that matches the name of the partner event source.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePartnerEventSourceInput) GoString added in v1.99.0 

func (s CreatePartnerEventSourceInput) GoString() string

GoString returns the string representation

func (*CreatePartnerEventSourceInput) SetAccount added in v1.99.0 

func (s *CreatePartnerEventSourceInput) SetAccount(v string) *CreatePartnerEventSourceInput

SetAccount sets the Account field's value.

func (*CreatePartnerEventSourceInput) SetName added in v1.99.0 

func (s *CreatePartnerEventSourceInput) SetName(v string) *CreatePartnerEventSourceInput

SetName sets the Name field's value.

func (CreatePartnerEventSourceInput) String added in v1.99.0 

func (s CreatePartnerEventSourceInput) String() string

String returns the string representation

func (*CreatePartnerEventSourceInput) Validate added in v1.99.0 

func (s *CreatePartnerEventSourceInput) Validate() error

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

type CreatePartnerEventSourceOutput added in v1.99.0 

type CreatePartnerEventSourceOutput struct {

	// The ARN of the partner event source.
	EventSourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreatePartnerEventSourceOutput) GoString added in v1.99.0 

func (s CreatePartnerEventSourceOutput) GoString() string

GoString returns the string representation

func (*CreatePartnerEventSourceOutput) SetEventSourceArn added in v1.99.0 

func (s *CreatePartnerEventSourceOutput) SetEventSourceArn(v string) *CreatePartnerEventSourceOutput

SetEventSourceArn sets the EventSourceArn field's value.

func (CreatePartnerEventSourceOutput) String added in v1.99.0 

func (s CreatePartnerEventSourceOutput) String() string

String returns the string representation

type DeactivateEventSourceInput added in v1.99.0 

type DeactivateEventSourceInput struct {

	// The name of the partner event source to deactivate.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeactivateEventSourceInput) GoString added in v1.99.0 

func (s DeactivateEventSourceInput) GoString() string

GoString returns the string representation

func (*DeactivateEventSourceInput) SetName added in v1.99.0 

func (s *DeactivateEventSourceInput) SetName(v string) *DeactivateEventSourceInput

SetName sets the Name field's value.

func (DeactivateEventSourceInput) String added in v1.99.0 

func (s DeactivateEventSourceInput) String() string

String returns the string representation

func (*DeactivateEventSourceInput) Validate added in v1.99.0 

func (s *DeactivateEventSourceInput) Validate() error

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

type DeactivateEventSourceOutput added in v1.99.0 

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

func (DeactivateEventSourceOutput) GoString added in v1.99.0 

func (s DeactivateEventSourceOutput) GoString() string

GoString returns the string representation

func (DeactivateEventSourceOutput) String added in v1.99.0 

func (s DeactivateEventSourceOutput) String() string

String returns the string representation

type DeleteEventBusInput added in v1.99.0 

type DeleteEventBusInput struct {

	// The name of the event bus to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventBusInput) GoString added in v1.99.0 

func (s DeleteEventBusInput) GoString() string

GoString returns the string representation

func (*DeleteEventBusInput) SetName added in v1.99.0 

func (s *DeleteEventBusInput) SetName(v string) *DeleteEventBusInput

SetName sets the Name field's value.

func (DeleteEventBusInput) String added in v1.99.0 

func (s DeleteEventBusInput) String() string

String returns the string representation

func (*DeleteEventBusInput) Validate added in v1.99.0 

func (s *DeleteEventBusInput) Validate() error

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

type DeleteEventBusOutput added in v1.99.0 

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

func (DeleteEventBusOutput) GoString added in v1.99.0 

func (s DeleteEventBusOutput) GoString() string

GoString returns the string representation

func (DeleteEventBusOutput) String added in v1.99.0 

func (s DeleteEventBusOutput) String() string

String returns the string representation

type DeletePartnerEventSourceInput added in v1.99.0 

type DeletePartnerEventSourceInput struct {

	// The AWS account ID of the AWS customer that the event source was created
	// for.
	//
	// Account is a required field
	Account *string `min:"12" type:"string" required:"true"`

	// The name of the event source to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePartnerEventSourceInput) GoString added in v1.99.0 

func (s DeletePartnerEventSourceInput) GoString() string

GoString returns the string representation

func (*DeletePartnerEventSourceInput) SetAccount added in v1.99.0 

func (s *DeletePartnerEventSourceInput) SetAccount(v string) *DeletePartnerEventSourceInput

SetAccount sets the Account field's value.

func (*DeletePartnerEventSourceInput) SetName added in v1.99.0 

func (s *DeletePartnerEventSourceInput) SetName(v string) *DeletePartnerEventSourceInput

SetName sets the Name field's value.

func (DeletePartnerEventSourceInput) String added in v1.99.0 

func (s DeletePartnerEventSourceInput) String() string

String returns the string representation

func (*DeletePartnerEventSourceInput) Validate added in v1.99.0 

func (s *DeletePartnerEventSourceInput) Validate() error

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

type DeletePartnerEventSourceOutput added in v1.99.0 

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

func (DeletePartnerEventSourceOutput) GoString added in v1.99.0 

func (s DeletePartnerEventSourceOutput) GoString() string

GoString returns the string representation

func (DeletePartnerEventSourceOutput) String added in v1.99.0 

func (s DeletePartnerEventSourceOutput) String() string

String returns the string representation

type DeleteRuleInput 

type DeleteRuleInput struct {

	// The event bus associated with the rule. If you omit this, the default event
	// bus is used.
	EventBusName *string `min:"1" type:"string"`

	// If this is a managed rule, created by an AWS service on your behalf, you
	// must specify Force as True to delete the rule. This parameter is ignored
	// for rules that are not managed rules. You can check whether a rule is a managed
	// rule by using DescribeRule or ListRules and checking the ManagedBy field
	// of the response.
	Force *bool `type:"boolean"`

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

func (DeleteRuleInput) GoString 

func (s DeleteRuleInput) GoString() string

GoString returns the string representation

func (*DeleteRuleInput) SetEventBusName added in v1.99.0 

func (s *DeleteRuleInput) SetEventBusName(v string) *DeleteRuleInput

SetEventBusName sets the EventBusName field's value.

func (*DeleteRuleInput) SetForce added in v1.99.0 

func (s *DeleteRuleInput) SetForce(v bool) *DeleteRuleInput

SetForce sets the Force field's value.

func (*DeleteRuleInput) SetName added in v1.5.0 

func (s *DeleteRuleInput) SetName(v string) *DeleteRuleInput

SetName sets the Name field's value.

func (DeleteRuleInput) String 

func (s DeleteRuleInput) String() string

String returns the string representation

func (*DeleteRuleInput) Validate added in v1.1.21 

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 DescribeEventBusInput added in v1.10.5 

type DescribeEventBusInput struct {

	// The name of the event bus to show details for. If you omit this, the default
	// event bus is displayed.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventBusInput) GoString added in v1.10.5 

func (s DescribeEventBusInput) GoString() string

GoString returns the string representation

func (*DescribeEventBusInput) SetName added in v1.99.0 

func (s *DescribeEventBusInput) SetName(v string) *DescribeEventBusInput

SetName sets the Name field's value.

func (DescribeEventBusInput) String added in v1.10.5 

func (s DescribeEventBusInput) String() string

String returns the string representation

func (*DescribeEventBusInput) Validate added in v1.99.0 

func (s *DescribeEventBusInput) Validate() error

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

type DescribeEventBusOutput added in v1.10.5 

type DescribeEventBusOutput struct {

	// The Amazon Resource Name (ARN) of the account permitted to write events to
	// the current account.
	Arn *string `type:"string"`

	// The name of the event bus. Currently, this is always default.
	Name *string `type:"string"`

	// The policy that enables the external account to send events to your account.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventBusOutput) GoString added in v1.10.5 

func (s DescribeEventBusOutput) GoString() string

GoString returns the string representation

func (*DescribeEventBusOutput) SetArn added in v1.10.5 

func (s *DescribeEventBusOutput) SetArn(v string) *DescribeEventBusOutput

SetArn sets the Arn field's value.

func (*DescribeEventBusOutput) SetName added in v1.10.5 

func (s *DescribeEventBusOutput) SetName(v string) *DescribeEventBusOutput

SetName sets the Name field's value.

func (*DescribeEventBusOutput) SetPolicy added in v1.10.5 

func (s *DescribeEventBusOutput) SetPolicy(v string) *DescribeEventBusOutput

SetPolicy sets the Policy field's value.

func (DescribeEventBusOutput) String added in v1.10.5 

func (s DescribeEventBusOutput) String() string

String returns the string representation

type DescribeEventSourceInput added in v1.99.0 

type DescribeEventSourceInput struct {

	// The name of the partner event source to display the details of.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEventSourceInput) GoString added in v1.99.0 

func (s DescribeEventSourceInput) GoString() string

GoString returns the string representation

func (*DescribeEventSourceInput) SetName added in v1.99.0 

func (s *DescribeEventSourceInput) SetName(v string) *DescribeEventSourceInput

SetName sets the Name field's value.

func (DescribeEventSourceInput) String added in v1.99.0 

func (s DescribeEventSourceInput) String() string

String returns the string representation

func (*DescribeEventSourceInput) Validate added in v1.99.0 

func (s *DescribeEventSourceInput) Validate() error

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

type DescribeEventSourceOutput added in v1.99.0 

type DescribeEventSourceOutput struct {

	// The ARN of the partner event source.
	Arn *string `type:"string"`

	// The name of the SaaS partner that created the event source.
	CreatedBy *string `type:"string"`

	// The date and time that the event source was created.
	CreationTime *time.Time `type:"timestamp"`

	// The date and time that the event source will expire if you don't create a
	// matching event bus.
	ExpirationTime *time.Time `type:"timestamp"`

	// The name of the partner event source.
	Name *string `type:"string"`

	// The state of the event source. If it's ACTIVE, you have already created a
	// matching event bus for this event source, and that event bus is active. If
	// it's PENDING, either you haven't yet created a matching event bus, or that
	// event bus is deactivated. If it's DELETED, you have created a matching event
	// bus, but the event source has since been deleted.
	State *string `type:"string" enum:"EventSourceState"`
	// contains filtered or unexported fields
}

func (DescribeEventSourceOutput) GoString added in v1.99.0 

func (s DescribeEventSourceOutput) GoString() string

GoString returns the string representation

func (*DescribeEventSourceOutput) SetArn added in v1.99.0 

func (s *DescribeEventSourceOutput) SetArn(v string) *DescribeEventSourceOutput

SetArn sets the Arn field's value.

func (*DescribeEventSourceOutput) SetCreatedBy added in v1.99.0 

func (s *DescribeEventSourceOutput) SetCreatedBy(v string) *DescribeEventSourceOutput

SetCreatedBy sets the CreatedBy field's value.

func (*DescribeEventSourceOutput) SetCreationTime added in v1.99.0 

func (s *DescribeEventSourceOutput) SetCreationTime(v time.Time) *DescribeEventSourceOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeEventSourceOutput) SetExpirationTime added in v1.99.0 

func (s *DescribeEventSourceOutput) SetExpirationTime(v time.Time) *DescribeEventSourceOutput

SetExpirationTime sets the ExpirationTime field's value.

func (*DescribeEventSourceOutput) SetName added in v1.99.0 

func (s *DescribeEventSourceOutput) SetName(v string) *DescribeEventSourceOutput

SetName sets the Name field's value.

func (*DescribeEventSourceOutput) SetState added in v1.99.0 

func (s *DescribeEventSourceOutput) SetState(v string) *DescribeEventSourceOutput

SetState sets the State field's value.

func (DescribeEventSourceOutput) String added in v1.99.0 

func (s DescribeEventSourceOutput) String() string

String returns the string representation

type DescribePartnerEventSourceInput added in v1.99.0 

type DescribePartnerEventSourceInput struct {

	// The name of the event source to display.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePartnerEventSourceInput) GoString added in v1.99.0 

func (s DescribePartnerEventSourceInput) GoString() string

GoString returns the string representation

func (*DescribePartnerEventSourceInput) SetName added in v1.99.0 

func (s *DescribePartnerEventSourceInput) SetName(v string) *DescribePartnerEventSourceInput

SetName sets the Name field's value.

func (DescribePartnerEventSourceInput) String added in v1.99.0 

func (s DescribePartnerEventSourceInput) String() string

String returns the string representation

func (*DescribePartnerEventSourceInput) Validate added in v1.99.0 

func (s *DescribePartnerEventSourceInput) Validate() error

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

type DescribePartnerEventSourceOutput added in v1.99.0 

type DescribePartnerEventSourceOutput struct {

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

	// The name of the event source.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePartnerEventSourceOutput) GoString added in v1.99.0 

func (s DescribePartnerEventSourceOutput) GoString() string

GoString returns the string representation

func (*DescribePartnerEventSourceOutput) SetArn added in v1.99.0 

func (s *DescribePartnerEventSourceOutput) SetArn(v string) *DescribePartnerEventSourceOutput

SetArn sets the Arn field's value.

func (*DescribePartnerEventSourceOutput) SetName added in v1.99.0 

func (s *DescribePartnerEventSourceOutput) SetName(v string) *DescribePartnerEventSourceOutput

SetName sets the Name field's value.

func (DescribePartnerEventSourceOutput) String added in v1.99.0 

func (s DescribePartnerEventSourceOutput) String() string

String returns the string representation

type DescribeRuleInput 

type DescribeRuleInput struct {

	// The event bus associated with the rule. If you omit this, the default event
	// bus is used.
	EventBusName *string `min:"1" type:"string"`

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

func (DescribeRuleInput) GoString 

func (s DescribeRuleInput) GoString() string

GoString returns the string representation

func (*DescribeRuleInput) SetEventBusName added in v1.99.0 

func (s *DescribeRuleInput) SetEventBusName(v string) *DescribeRuleInput

SetEventBusName sets the EventBusName field's value.

func (*DescribeRuleInput) SetName added in v1.5.0 

func (s *DescribeRuleInput) SetName(v string) *DescribeRuleInput

SetName sets the Name field's value.

func (DescribeRuleInput) String 

func (s DescribeRuleInput) String() string

String returns the string representation

func (*DescribeRuleInput) Validate added in v1.1.21 

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) of the rule.
	Arn *string `min:"1" type:"string"`

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

	// The event bus associated with the rule.
	EventBusName *string `min:"1" type:"string"`

	// The event pattern. For more information, see Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	EventPattern *string `type:"string"`

	// If this is a managed rule, created by an AWS service on your behalf, this
	// field displays the principal name of the AWS service that created the rule.
	ManagedBy *string `min:"1" type:"string"`

	// The name of the rule.
	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 * * ? *)" or "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
}

func (DescribeRuleOutput) GoString 

func (s DescribeRuleOutput) GoString() string

GoString returns the string representation

func (*DescribeRuleOutput) SetArn added in v1.5.0 

func (s *DescribeRuleOutput) SetArn(v string) *DescribeRuleOutput

SetArn sets the Arn field's value.

func (*DescribeRuleOutput) SetDescription added in v1.5.0 

func (s *DescribeRuleOutput) SetDescription(v string) *DescribeRuleOutput

SetDescription sets the Description field's value.

func (*DescribeRuleOutput) SetEventBusName added in v1.99.0 

func (s *DescribeRuleOutput) SetEventBusName(v string) *DescribeRuleOutput

SetEventBusName sets the EventBusName field's value.

func (*DescribeRuleOutput) SetEventPattern added in v1.5.0 

func (s *DescribeRuleOutput) SetEventPattern(v string) *DescribeRuleOutput

SetEventPattern sets the EventPattern field's value.

func (*DescribeRuleOutput) SetManagedBy added in v1.99.0 

func (s *DescribeRuleOutput) SetManagedBy(v string) *DescribeRuleOutput

SetManagedBy sets the ManagedBy field's value.

func (*DescribeRuleOutput) SetName added in v1.5.0 

func (s *DescribeRuleOutput) SetName(v string) *DescribeRuleOutput

SetName sets the Name field's value.

func (*DescribeRuleOutput) SetRoleArn added in v1.5.0 

func (s *DescribeRuleOutput) SetRoleArn(v string) *DescribeRuleOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeRuleOutput) SetScheduleExpression added in v1.5.0 

func (s *DescribeRuleOutput) SetScheduleExpression(v string) *DescribeRuleOutput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*DescribeRuleOutput) SetState added in v1.5.0 

func (s *DescribeRuleOutput) SetState(v string) *DescribeRuleOutput

SetState sets the State field's value.

func (DescribeRuleOutput) String 

func (s DescribeRuleOutput) String() string

String returns the string representation

type DisableRuleInput 

type DisableRuleInput struct {

	// The event bus associated with the rule. If you omit this, the default event
	// bus is used.
	EventBusName *string `min:"1" type:"string"`

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

func (DisableRuleInput) GoString 

func (s DisableRuleInput) GoString() string

GoString returns the string representation

func (*DisableRuleInput) SetEventBusName added in v1.99.0 

func (s *DisableRuleInput) SetEventBusName(v string) *DisableRuleInput

SetEventBusName sets the EventBusName field's value.

func (*DisableRuleInput) SetName added in v1.5.0 

func (s *DisableRuleInput) SetName(v string) *DisableRuleInput

SetName sets the Name field's value.

func (DisableRuleInput) String 

func (s DisableRuleInput) String() string

String returns the string representation

func (*DisableRuleInput) Validate added in v1.1.21 

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 EcsParameters added in v1.7.9 

type EcsParameters struct {

	// Specifies an ECS task group for the task. The maximum length is 255 characters.
	Group *string `type:"string"`

	// Specifies the launch type on which your task is running. The launch type
	// that you specify here must match one of the launch type (compatibilities)
	// of the target task. The FARGATE value is supported only in the Regions where
	// AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate
	// on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html)
	// in the Amazon Elastic Container Service Developer Guide.
	LaunchType *string `type:"string" enum:"LaunchType"`

	// Use this structure if the ECS task uses the awsvpc network mode. This structure
	// specifies the VPC subnets and security groups associated with the task and
	// whether a public IP address is to be used. This structure is required if
	// LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
	//
	// If you specify NetworkConfiguration when the target ECS task doesn't use
	// the awsvpc network mode, the task fails.
	NetworkConfiguration *NetworkConfiguration `type:"structure"`

	// Specifies the platform version for the task. Specify only the numeric portion
	// of the platform version, such as 1.1.0.
	//
	// This structure is used only if LaunchType is FARGATE. For more information
	// about valid platform versions, see AWS Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `type:"string"`

	// The number of tasks to create based on TaskDefinition. The default is 1.
	TaskCount *int64 `min:"1" type:"integer"`

	// The ARN of the task definition to use if the event target is an Amazon ECS
	// task.
	//
	// TaskDefinitionArn is a required field
	TaskDefinitionArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The custom parameters to be used when the target is an Amazon ECS task.

func (EcsParameters) GoString added in v1.7.9 

func (s EcsParameters) GoString() string

GoString returns the string representation

func (*EcsParameters) SetGroup added in v1.99.0 

func (s *EcsParameters) SetGroup(v string) *EcsParameters

SetGroup sets the Group field's value.

func (*EcsParameters) SetLaunchType added in v1.99.0 

func (s *EcsParameters) SetLaunchType(v string) *EcsParameters

SetLaunchType sets the LaunchType field's value.

func (*EcsParameters) SetNetworkConfiguration added in v1.99.0 

func (s *EcsParameters) SetNetworkConfiguration(v *NetworkConfiguration) *EcsParameters

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*EcsParameters) SetPlatformVersion added in v1.99.0 

func (s *EcsParameters) SetPlatformVersion(v string) *EcsParameters

SetPlatformVersion sets the PlatformVersion field's value.

func (*EcsParameters) SetTaskCount added in v1.7.9 

func (s *EcsParameters) SetTaskCount(v int64) *EcsParameters

SetTaskCount sets the TaskCount field's value.

func (*EcsParameters) SetTaskDefinitionArn added in v1.7.9 

func (s *EcsParameters) SetTaskDefinitionArn(v string) *EcsParameters

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (EcsParameters) String added in v1.7.9 

func (s EcsParameters) String() string

String returns the string representation

func (*EcsParameters) Validate added in v1.7.9 

func (s *EcsParameters) Validate() error

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

type EnableRuleInput 

type EnableRuleInput struct {

	// The event bus associated with the rule. If you omit this, the default event
	// bus is used.
	EventBusName *string `min:"1" type:"string"`

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

func (EnableRuleInput) GoString 

func (s EnableRuleInput) GoString() string

GoString returns the string representation

func (*EnableRuleInput) SetEventBusName added in v1.99.0 

func (s *EnableRuleInput) SetEventBusName(v string) *EnableRuleInput

SetEventBusName sets the EventBusName field's value.

func (*EnableRuleInput) SetName added in v1.5.0 

func (s *EnableRuleInput) SetName(v string) *EnableRuleInput

SetName sets the Name field's value.

func (EnableRuleInput) String 

func (s EnableRuleInput) String() string

String returns the string representation

func (*EnableRuleInput) Validate added in v1.1.21 

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 EventBus added in v1.99.0 

type EventBus struct {

	// The ARN of the event bus.
	Arn *string `type:"string"`

	// The name of the event bus.
	Name *string `type:"string"`

	// The permissions policy of the event bus, describing which other AWS accounts
	// can write events to this event bus.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives rules from AWS services. A custom event bus can receive rules from AWS services as well as your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

func (EventBus) GoString added in v1.99.0 

func (s EventBus) GoString() string

GoString returns the string representation

func (*EventBus) SetArn added in v1.99.0 

func (s *EventBus) SetArn(v string) *EventBus

SetArn sets the Arn field's value.

func (*EventBus) SetName added in v1.99.0 

func (s *EventBus) SetName(v string) *EventBus

SetName sets the Name field's value.

func (*EventBus) SetPolicy added in v1.99.0 

func (s *EventBus) SetPolicy(v string) *EventBus

SetPolicy sets the Policy field's value.

func (EventBus) String added in v1.99.0 

func (s EventBus) String() string

String returns the string representation

type EventSource added in v1.99.0 

type EventSource struct {

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

	// The name of the partner that created the event source.
	CreatedBy *string `type:"string"`

	// The date and time when the event source was created.
	CreationTime *time.Time `type:"timestamp"`

	// The date and time when the event source will expire if the AWS account doesn't
	// create a matching event bus for it.
	ExpirationTime *time.Time `type:"timestamp"`

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

	// The state of the event source. If it's ACTIVE, you have already created a
	// matching event bus for this event source, and that event bus is active. If
	// it's PENDING, either you haven't yet created a matching event bus, or that
	// event bus is deactivated. If it's DELETED, you have created a matching event
	// bus, but the event source has since been deleted.
	State *string `type:"string" enum:"EventSourceState"`
	// contains filtered or unexported fields
}

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.

func (EventSource) GoString added in v1.99.0 

func (s EventSource) GoString() string

GoString returns the string representation

func (*EventSource) SetArn added in v1.99.0 

func (s *EventSource) SetArn(v string) *EventSource

SetArn sets the Arn field's value.

func (*EventSource) SetCreatedBy added in v1.99.0 

func (s *EventSource) SetCreatedBy(v string) *EventSource

SetCreatedBy sets the CreatedBy field's value.

func (*EventSource) SetCreationTime added in v1.99.0 

func (s *EventSource) SetCreationTime(v time.Time) *EventSource

SetCreationTime sets the CreationTime field's value.

func (*EventSource) SetExpirationTime added in v1.99.0 

func (s *EventSource) SetExpirationTime(v time.Time) *EventSource

SetExpirationTime sets the ExpirationTime field's value.

func (*EventSource) SetName added in v1.99.0 

func (s *EventSource) SetName(v string) *EventSource

SetName sets the Name field's value.

func (*EventSource) SetState added in v1.99.0 

func (s *EventSource) SetState(v string) *EventSource

SetState sets the State field's value.

func (EventSource) String added in v1.99.0 

func (s EventSource) String() string

String returns the string representation

type InputTransformer added in v1.7.9 

type InputTransformer struct {

	// Map of JSON paths to be extracted from the event. You can then insert these
	// in the template in InputTemplate to produce the output to be sent to the
	// target.
	//
	// InputPathsMap is an array key-value pairs, where each value is a valid JSON
	// path. You can have as many as 10 key-value pairs. You must use JSON dot notation,
	// not bracket notation.
	//
	// The keys can't start with "AWS".
	InputPathsMap map[string]*string `type:"map"`

	// Input template where you specify placeholders that will be filled with the
	// values of the keys from InputPathsMap to customize the data sent to the target.
	// Enclose each InputPathsMaps value in brackets: <value>. The InputTemplate
	// must be valid JSON.
	//
	// If InputTemplate is a JSON object (surrounded by curly braces), the following
	// restrictions apply:
	//
	//    * The placeholder can't be used as an object key
	//
	//    * Object values can't include quote marks
	//
	// The following example shows the syntax for using InputPathsMap and InputTemplate.
	//
	// "InputTransformer":
	//
	// {
	//
	// "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
	//
	// "InputTemplate": "<instance> is in state <status>"
	//
	// }
	//
	// To have the InputTemplate include quote marks within a JSON string, escape
	// each quote marks with a slash, as in the following example:
	//
	// "InputTransformer":
	//
	// {
	//
	// "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
	//
	// "InputTemplate": "<instance> is in state \"<status>\""
	//
	// }
	//
	// InputTemplate is a required field
	InputTemplate *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

func (InputTransformer) GoString added in v1.7.9 

func (s InputTransformer) GoString() string

GoString returns the string representation

func (*InputTransformer) SetInputPathsMap added in v1.7.9 

func (s *InputTransformer) SetInputPathsMap(v map[string]*string) *InputTransformer

SetInputPathsMap sets the InputPathsMap field's value.

func (*InputTransformer) SetInputTemplate added in v1.7.9 

func (s *InputTransformer) SetInputTemplate(v string) *InputTransformer

SetInputTemplate sets the InputTemplate field's value.

func (InputTransformer) String added in v1.7.9 

func (s InputTransformer) String() string

String returns the string representation

func (*InputTransformer) Validate added in v1.7.9 

func (s *InputTransformer) Validate() error

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

type KinesisParameters added in v1.7.9 

type KinesisParameters struct {

	// The JSON path to be extracted from the event and used as the partition key.
	// For more information, see Amazon Kinesis Streams Key Concepts (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key)
	// in the Amazon Kinesis Streams Developer Guide.
	//
	// PartitionKeyPath is a required field
	PartitionKeyPath *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream so that you can control the shard that the event goes to. If you don't include this parameter, the default is to use the eventId as the partition key.

func (KinesisParameters) GoString added in v1.7.9 

func (s KinesisParameters) GoString() string

GoString returns the string representation

func (*KinesisParameters) SetPartitionKeyPath added in v1.7.9 

func (s *KinesisParameters) SetPartitionKeyPath(v string) *KinesisParameters

SetPartitionKeyPath sets the PartitionKeyPath field's value.

func (KinesisParameters) String added in v1.7.9 

func (s KinesisParameters) String() string

String returns the string representation

func (*KinesisParameters) Validate added in v1.7.9 

func (s *KinesisParameters) Validate() error

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

type ListEventBusesInput added in v1.99.0 

type ListEventBusesInput struct {

	// Specifying this limits the number of results returned by this operation.
	// The operation also returns a NextToken that you can use in a subsequent operation
	// to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// Specifying this limits the results to only those event buses with names that
	// start with the specified prefix.
	NamePrefix *string `min:"1" type:"string"`

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventBusesInput) GoString added in v1.99.0 

func (s ListEventBusesInput) GoString() string

GoString returns the string representation

func (*ListEventBusesInput) SetLimit added in v1.99.0 

func (s *ListEventBusesInput) SetLimit(v int64) *ListEventBusesInput

SetLimit sets the Limit field's value.

func (*ListEventBusesInput) SetNamePrefix added in v1.99.0 

func (s *ListEventBusesInput) SetNamePrefix(v string) *ListEventBusesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListEventBusesInput) SetNextToken added in v1.99.0 

func (s *ListEventBusesInput) SetNextToken(v string) *ListEventBusesInput

SetNextToken sets the NextToken field's value.

func (ListEventBusesInput) String added in v1.99.0 

func (s ListEventBusesInput) String() string

String returns the string representation

func (*ListEventBusesInput) Validate added in v1.99.0 

func (s *ListEventBusesInput) Validate() error

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

type ListEventBusesOutput added in v1.99.0 

type ListEventBusesOutput struct {

	// This list of event buses.
	EventBuses []*EventBus `type:"list"`

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventBusesOutput) GoString added in v1.99.0 

func (s ListEventBusesOutput) GoString() string

GoString returns the string representation

func (*ListEventBusesOutput) SetEventBuses added in v1.99.0 

func (s *ListEventBusesOutput) SetEventBuses(v []*EventBus) *ListEventBusesOutput

SetEventBuses sets the EventBuses field's value.

func (*ListEventBusesOutput) SetNextToken added in v1.99.0 

func (s *ListEventBusesOutput) SetNextToken(v string) *ListEventBusesOutput

SetNextToken sets the NextToken field's value.

func (ListEventBusesOutput) String added in v1.99.0 

func (s ListEventBusesOutput) String() string

String returns the string representation

type ListEventSourcesInput added in v1.99.0 

type ListEventSourcesInput struct {

	// Specifying this limits the number of results returned by this operation.
	// The operation also returns a NextToken that you can use in a subsequent operation
	// to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// Specifying this limits the results to only those partner event sources with
	// names that start with the specified prefix.
	NamePrefix *string `min:"1" type:"string"`

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventSourcesInput) GoString added in v1.99.0 

func (s ListEventSourcesInput) GoString() string

GoString returns the string representation

func (*ListEventSourcesInput) SetLimit added in v1.99.0 

func (s *ListEventSourcesInput) SetLimit(v int64) *ListEventSourcesInput

SetLimit sets the Limit field's value.

func (*ListEventSourcesInput) SetNamePrefix added in v1.99.0 

func (s *ListEventSourcesInput) SetNamePrefix(v string) *ListEventSourcesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListEventSourcesInput) SetNextToken added in v1.99.0 

func (s *ListEventSourcesInput) SetNextToken(v string) *ListEventSourcesInput

SetNextToken sets the NextToken field's value.

func (ListEventSourcesInput) String added in v1.99.0 

func (s ListEventSourcesInput) String() string

String returns the string representation

func (*ListEventSourcesInput) Validate added in v1.99.0 

func (s *ListEventSourcesInput) Validate() error

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

type ListEventSourcesOutput added in v1.99.0 

type ListEventSourcesOutput struct {

	// The list of event sources.
	EventSources []*EventSource `type:"list"`

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventSourcesOutput) GoString added in v1.99.0 

func (s ListEventSourcesOutput) GoString() string

GoString returns the string representation

func (*ListEventSourcesOutput) SetEventSources added in v1.99.0 

func (s *ListEventSourcesOutput) SetEventSources(v []*EventSource) *ListEventSourcesOutput

SetEventSources sets the EventSources field's value.

func (*ListEventSourcesOutput) SetNextToken added in v1.99.0 

func (s *ListEventSourcesOutput) SetNextToken(v string) *ListEventSourcesOutput

SetNextToken sets the NextToken field's value.

func (ListEventSourcesOutput) String added in v1.99.0 

func (s ListEventSourcesOutput) String() string

String returns the string representation

type ListPartnerEventSourceAccountsInput added in v1.99.0 

type ListPartnerEventSourceAccountsInput struct {

	// The name of the partner event source to display account information about.
	//
	// EventSourceName is a required field
	EventSourceName *string `min:"1" type:"string" required:"true"`

	// Specifying this limits the number of results returned by this operation.
	// The operation also returns a NextToken that you can use in a subsequent operation
	// to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// The token returned by a previous call to this operation. Specifying this
	// retrieves the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourceAccountsInput) GoString added in v1.99.0 

func (s ListPartnerEventSourceAccountsInput) GoString() string

GoString returns the string representation

func (*ListPartnerEventSourceAccountsInput) SetEventSourceName added in v1.99.0 

func (s *ListPartnerEventSourceAccountsInput) SetEventSourceName(v string) *ListPartnerEventSourceAccountsInput

SetEventSourceName sets the EventSourceName field's value.

func (*ListPartnerEventSourceAccountsInput) SetLimit added in v1.99.0 

func (s *ListPartnerEventSourceAccountsInput) SetLimit(v int64) *ListPartnerEventSourceAccountsInput

SetLimit sets the Limit field's value.

func (*ListPartnerEventSourceAccountsInput) SetNextToken added in v1.99.0 

func (s *ListPartnerEventSourceAccountsInput) SetNextToken(v string) *ListPartnerEventSourceAccountsInput

SetNextToken sets the NextToken field's value.

func (ListPartnerEventSourceAccountsInput) String added in v1.99.0 

func (s ListPartnerEventSourceAccountsInput) String() string

String returns the string representation

func (*ListPartnerEventSourceAccountsInput) Validate added in v1.99.0 

func (s *ListPartnerEventSourceAccountsInput) Validate() error

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

type ListPartnerEventSourceAccountsOutput added in v1.99.0 

type ListPartnerEventSourceAccountsOutput struct {

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`

	// The list of partner event sources returned by the operation.
	PartnerEventSourceAccounts []*PartnerEventSourceAccount `type:"list"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourceAccountsOutput) GoString added in v1.99.0 

func (s ListPartnerEventSourceAccountsOutput) GoString() string

GoString returns the string representation

func (*ListPartnerEventSourceAccountsOutput) SetNextToken added in v1.99.0 

func (s *ListPartnerEventSourceAccountsOutput) SetNextToken(v string) *ListPartnerEventSourceAccountsOutput

SetNextToken sets the NextToken field's value.

func (*ListPartnerEventSourceAccountsOutput) SetPartnerEventSourceAccounts added in v1.99.0 

func (s *ListPartnerEventSourceAccountsOutput) SetPartnerEventSourceAccounts(v []*PartnerEventSourceAccount) *ListPartnerEventSourceAccountsOutput

SetPartnerEventSourceAccounts sets the PartnerEventSourceAccounts field's value.

func (ListPartnerEventSourceAccountsOutput) String added in v1.99.0 

func (s ListPartnerEventSourceAccountsOutput) String() string

String returns the string representation

type ListPartnerEventSourcesInput added in v1.99.0 

type ListPartnerEventSourcesInput struct {

	// pecifying this limits the number of results returned by this operation. The
	// operation also returns a NextToken that you can use in a subsequent operation
	// to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// If you specify this, the results are limited to only those partner event
	// sources that start with the string you specify.
	//
	// NamePrefix is a required field
	NamePrefix *string `min:"1" type:"string" required:"true"`

	// The token returned by a previous call to this operation. Specifying this
	// retrieves the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourcesInput) GoString added in v1.99.0 

func (s ListPartnerEventSourcesInput) GoString() string

GoString returns the string representation

func (*ListPartnerEventSourcesInput) SetLimit added in v1.99.0 

func (s *ListPartnerEventSourcesInput) SetLimit(v int64) *ListPartnerEventSourcesInput

SetLimit sets the Limit field's value.

func (*ListPartnerEventSourcesInput) SetNamePrefix added in v1.99.0 

func (s *ListPartnerEventSourcesInput) SetNamePrefix(v string) *ListPartnerEventSourcesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListPartnerEventSourcesInput) SetNextToken added in v1.99.0 

func (s *ListPartnerEventSourcesInput) SetNextToken(v string) *ListPartnerEventSourcesInput

SetNextToken sets the NextToken field's value.

func (ListPartnerEventSourcesInput) String added in v1.99.0 

func (s ListPartnerEventSourcesInput) String() string

String returns the string representation

func (*ListPartnerEventSourcesInput) Validate added in v1.99.0 

func (s *ListPartnerEventSourcesInput) Validate() error

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

type ListPartnerEventSourcesOutput added in v1.99.0 

type ListPartnerEventSourcesOutput struct {

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`

	// The list of partner event sources returned by the operation.
	PartnerEventSources []*PartnerEventSource `type:"list"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourcesOutput) GoString added in v1.99.0 

func (s ListPartnerEventSourcesOutput) GoString() string

GoString returns the string representation

func (*ListPartnerEventSourcesOutput) SetNextToken added in v1.99.0 

func (s *ListPartnerEventSourcesOutput) SetNextToken(v string) *ListPartnerEventSourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListPartnerEventSourcesOutput) SetPartnerEventSources added in v1.99.0 

func (s *ListPartnerEventSourcesOutput) SetPartnerEventSources(v []*PartnerEventSource) *ListPartnerEventSourcesOutput

SetPartnerEventSources sets the PartnerEventSources field's value.

func (ListPartnerEventSourcesOutput) String added in v1.99.0 

func (s ListPartnerEventSourcesOutput) String() string

String returns the string representation

type ListRuleNamesByTargetInput 

type ListRuleNamesByTargetInput struct {

	// Limits the results to show only the rules associated with the specified event
	// bus.
	EventBusName *string `min:"1" type:"string"`

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

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the target resource.
	//
	// TargetArn is a required field
	TargetArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListRuleNamesByTargetInput) GoString 

func (s ListRuleNamesByTargetInput) GoString() string

GoString returns the string representation

func (*ListRuleNamesByTargetInput) SetEventBusName added in v1.99.0 

func (s *ListRuleNamesByTargetInput) SetEventBusName(v string) *ListRuleNamesByTargetInput

SetEventBusName sets the EventBusName field's value.

func (*ListRuleNamesByTargetInput) SetLimit added in v1.5.0 

func (s *ListRuleNamesByTargetInput) SetLimit(v int64) *ListRuleNamesByTargetInput

SetLimit sets the Limit field's value.

func (*ListRuleNamesByTargetInput) SetNextToken added in v1.5.0 

func (s *ListRuleNamesByTargetInput) SetNextToken(v string) *ListRuleNamesByTargetInput

SetNextToken sets the NextToken field's value.

func (*ListRuleNamesByTargetInput) SetTargetArn added in v1.5.0 

func (s *ListRuleNamesByTargetInput) SetTargetArn(v string) *ListRuleNamesByTargetInput

SetTargetArn sets the TargetArn field's value.

func (ListRuleNamesByTargetInput) String 

func (s ListRuleNamesByTargetInput) String() string

String returns the string representation

func (*ListRuleNamesByTargetInput) Validate added in v1.1.21 

func (s *ListRuleNamesByTargetInput) Validate() error

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

type ListRuleNamesByTargetOutput 

type ListRuleNamesByTargetOutput struct {

	// Indicates whether there are additional results to retrieve. If there are
	// no more results, the value is null.
	NextToken *string `min:"1" type:"string"`

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

func (ListRuleNamesByTargetOutput) GoString 

func (s ListRuleNamesByTargetOutput) GoString() string

GoString returns the string representation

func (*ListRuleNamesByTargetOutput) SetNextToken added in v1.5.0 

func (s *ListRuleNamesByTargetOutput) SetNextToken(v string) *ListRuleNamesByTargetOutput

SetNextToken sets the NextToken field's value.

func (*ListRuleNamesByTargetOutput) SetRuleNames added in v1.5.0 

func (s *ListRuleNamesByTargetOutput) SetRuleNames(v []*string) *ListRuleNamesByTargetOutput

SetRuleNames sets the RuleNames field's value.

func (ListRuleNamesByTargetOutput) String 

func (s ListRuleNamesByTargetOutput) String() string

String returns the string representation

type ListRulesInput 

type ListRulesInput struct {

	// Limits the results to show only the rules associated with the specified event
	// bus.
	EventBusName *string `min:"1" type:"string"`

	// 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 retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRulesInput) GoString 

func (s ListRulesInput) GoString() string

GoString returns the string representation

func (*ListRulesInput) SetEventBusName added in v1.99.0 

func (s *ListRulesInput) SetEventBusName(v string) *ListRulesInput

SetEventBusName sets the EventBusName field's value.

func (*ListRulesInput) SetLimit added in v1.5.0 

func (s *ListRulesInput) SetLimit(v int64) *ListRulesInput

SetLimit sets the Limit field's value.

func (*ListRulesInput) SetNamePrefix added in v1.5.0 

func (s *ListRulesInput) SetNamePrefix(v string) *ListRulesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListRulesInput) SetNextToken added in v1.5.0 

func (s *ListRulesInput) SetNextToken(v string) *ListRulesInput

SetNextToken sets the NextToken field's value.

func (ListRulesInput) String 

func (s ListRulesInput) String() string

String returns the string representation

func (*ListRulesInput) Validate added in v1.1.21 

func (s *ListRulesInput) Validate() error

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

type ListRulesOutput 

type ListRulesOutput struct {

	// Indicates whether there are additional results to retrieve. If there are
	// no more results, the value is null.
	NextToken *string `min:"1" type:"string"`

	// The rules that match the specified criteria.
	Rules []*Rule `type:"list"`
	// contains filtered or unexported fields
}

func (ListRulesOutput) GoString 

func (s ListRulesOutput) GoString() string

GoString returns the string representation

func (*ListRulesOutput) SetNextToken added in v1.5.0 

func (s *ListRulesOutput) SetNextToken(v string) *ListRulesOutput

SetNextToken sets the NextToken field's value.

func (*ListRulesOutput) SetRules added in v1.5.0 

func (s *ListRulesOutput) SetRules(v []*Rule) *ListRulesOutput

SetRules sets the Rules field's value.

func (ListRulesOutput) String 

func (s ListRulesOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.99.0 

type ListTagsForResourceInput struct {

	// The ARN of the rule for which you want to view tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.99.0 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceARN added in v1.99.0 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.99.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.99.0 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.99.0 

type ListTagsForResourceOutput struct {

	// The list of tag keys and values associated with the rule that you specified.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.99.0 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.99.0 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.99.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTargetsByRuleInput 

type ListTargetsByRuleInput struct {

	// The event bus associated with the rule. If you omit this, the default event
	// bus is used.
	EventBusName *string `min:"1" type:"string"`

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

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The name of the rule.
	//
	// Rule is a required field
	Rule *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTargetsByRuleInput) GoString 

func (s ListTargetsByRuleInput) GoString() string

GoString returns the string representation

func (*ListTargetsByRuleInput) SetEventBusName added in v1.99.0 

func (s *ListTargetsByRuleInput) SetEventBusName(v string) *ListTargetsByRuleInput

SetEventBusName sets the EventBusName field's value.

func (*ListTargetsByRuleInput) SetLimit added in v1.5.0 

func (s *ListTargetsByRuleInput) SetLimit(v int64) *ListTargetsByRuleInput

SetLimit sets the Limit field's value.

func (*ListTargetsByRuleInput) SetNextToken added in v1.5.0 

func (s *ListTargetsByRuleInput) SetNextToken(v string) *ListTargetsByRuleInput

SetNextToken sets the NextToken field's value.

func (*ListTargetsByRuleInput) SetRule added in v1.5.0 

func (s *ListTargetsByRuleInput) SetRule(v string) *ListTargetsByRuleInput

SetRule sets the Rule field's value.

func (ListTargetsByRuleInput) String 

func (s ListTargetsByRuleInput) String() string

String returns the string representation

func (*ListTargetsByRuleInput) Validate added in v1.1.21 

func (s *ListTargetsByRuleInput) Validate() error

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

type ListTargetsByRuleOutput 

type ListTargetsByRuleOutput struct {

	// Indicates whether there are additional results to retrieve. If there are
	// no more results, the value is null.
	NextToken *string `min:"1" type:"string"`

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

func (ListTargetsByRuleOutput) GoString 

func (s ListTargetsByRuleOutput) GoString() string

GoString returns the string representation

func (*ListTargetsByRuleOutput) SetNextToken added in v1.5.0 

func (s *ListTargetsByRuleOutput) SetNextToken(v string) *ListTargetsByRuleOutput

SetNextToken sets the NextToken field's value.

func (*ListTargetsByRuleOutput) SetTargets added in v1.5.0 

func (s *ListTargetsByRuleOutput) SetTargets(v []*Target) *ListTargetsByRuleOutput

SetTargets sets the Targets field's value.

func (ListTargetsByRuleOutput) String 

func (s ListTargetsByRuleOutput) String() string

String returns the string representation

type NetworkConfiguration added in v1.99.0 

type NetworkConfiguration struct {

	// Use this structure to specify the VPC subnets and security groups for the
	// task and whether a public IP address is to be used. This structure is relevant
	// only for ECS tasks that use the awsvpc network mode.
	AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

This structure specifies the network configuration for an ECS task.

func (NetworkConfiguration) GoString added in v1.99.0 

func (s NetworkConfiguration) GoString() string

GoString returns the string representation

func (*NetworkConfiguration) SetAwsvpcConfiguration added in v1.99.0 

func (s *NetworkConfiguration) SetAwsvpcConfiguration(v *AwsVpcConfiguration) *NetworkConfiguration

SetAwsvpcConfiguration sets the AwsvpcConfiguration field's value.

func (NetworkConfiguration) String added in v1.99.0 

func (s NetworkConfiguration) String() string

String returns the string representation

func (*NetworkConfiguration) Validate added in v1.99.0 

func (s *NetworkConfiguration) Validate() error

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

type PartnerEventSource added in v1.99.0 

type PartnerEventSource struct {

	// The ARN of the partner event source.
	Arn *string `type:"string"`

	// The name of the partner event source.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.

func (PartnerEventSource) GoString added in v1.99.0 

func (s PartnerEventSource) GoString() string

GoString returns the string representation

func (*PartnerEventSource) SetArn added in v1.99.0 

func (s *PartnerEventSource) SetArn(v string) *PartnerEventSource

SetArn sets the Arn field's value.

func (*PartnerEventSource) SetName added in v1.99.0 

func (s *PartnerEventSource) SetName(v string) *PartnerEventSource

SetName sets the Name field's value.

func (PartnerEventSource) String added in v1.99.0 

func (s PartnerEventSource) String() string

String returns the string representation

type PartnerEventSourceAccount added in v1.99.0 

type PartnerEventSourceAccount struct {

	// The AWS account ID that the partner event source was offered to.
	Account *string `min:"12" type:"string"`

	// The date and time when the event source was created.
	CreationTime *time.Time `type:"timestamp"`

	// The date and time when the event source will expire if the AWS account doesn't
	// create a matching event bus for it.
	ExpirationTime *time.Time `type:"timestamp"`

	// The state of the event source. If it's ACTIVE, you have already created a
	// matching event bus for this event source, and that event bus is active. If
	// it's PENDING, either you haven't yet created a matching event bus, or that
	// event bus is deactivated. If it's DELETED, you have created a matching event
	// bus, but the event source has since been deleted.
	State *string `type:"string" enum:"EventSourceState"`
	// contains filtered or unexported fields
}

The AWS account that a partner event source has been offered to.

func (PartnerEventSourceAccount) GoString added in v1.99.0 

func (s PartnerEventSourceAccount) GoString() string

GoString returns the string representation

func (*PartnerEventSourceAccount) SetAccount added in v1.99.0 

func (s *PartnerEventSourceAccount) SetAccount(v string) *PartnerEventSourceAccount

SetAccount sets the Account field's value.

func (*PartnerEventSourceAccount) SetCreationTime added in v1.99.0 

func (s *PartnerEventSourceAccount) SetCreationTime(v time.Time) *PartnerEventSourceAccount

SetCreationTime sets the CreationTime field's value.

func (*PartnerEventSourceAccount) SetExpirationTime added in v1.99.0 

func (s *PartnerEventSourceAccount) SetExpirationTime(v time.Time) *PartnerEventSourceAccount

SetExpirationTime sets the ExpirationTime field's value.

func (*PartnerEventSourceAccount) SetState added in v1.99.0 

func (s *PartnerEventSourceAccount) SetState(v string) *PartnerEventSourceAccount

SetState sets the State field's value.

func (PartnerEventSourceAccount) String added in v1.99.0 

func (s PartnerEventSourceAccount) 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 is a required field
	Entries []*PutEventsRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventsInput) GoString 

func (s PutEventsInput) GoString() string

GoString returns the string representation

func (*PutEventsInput) SetEntries added in v1.5.0 

func (s *PutEventsInput) SetEntries(v []*PutEventsRequestEntry) *PutEventsInput

SetEntries sets the Entries field's value.

func (PutEventsInput) String 

func (s PutEventsInput) String() string

String returns the string representation

func (*PutEventsInput) Validate added in v1.1.21 

func (s *PutEventsInput) Validate() error

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

type PutEventsOutput 

type PutEventsOutput struct {

	// The successfully and unsuccessfully ingested events results. If the ingestion
	// was successful, the entry has the event ID in it. Otherwise, you can use
	// the error code and error message 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
}

func (PutEventsOutput) GoString 

func (s PutEventsOutput) GoString() string

GoString returns the string representation

func (*PutEventsOutput) SetEntries added in v1.5.0 

func (s *PutEventsOutput) SetEntries(v []*PutEventsResultEntry) *PutEventsOutput

SetEntries sets the Entries field's value.

func (*PutEventsOutput) SetFailedEntryCount added in v1.5.0 

func (s *PutEventsOutput) SetFailedEntryCount(v int64) *PutEventsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (PutEventsOutput) String 

func (s PutEventsOutput) String() string

String returns the string representation

type PutEventsRequestEntry 

type PutEventsRequestEntry struct {

	// A valid JSON string. There is no other schema imposed. The JSON string can
	// contain fields and nested subobjects.
	Detail *string `type:"string"`

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

	// The event bus that will receive the event. Only the rules that are associated
	// with this event bus can match the event.
	EventBusName *string `min:"1" type:"string"`

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

	// The source of the event. This field is required.
	Source *string `type:"string"`

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

Represents an event to be submitted.

func (PutEventsRequestEntry) GoString 

func (s PutEventsRequestEntry) GoString() string

GoString returns the string representation

func (*PutEventsRequestEntry) SetDetail added in v1.5.0 

func (s *PutEventsRequestEntry) SetDetail(v string) *PutEventsRequestEntry

SetDetail sets the Detail field's value.

func (*PutEventsRequestEntry) SetDetailType added in v1.5.0 

func (s *PutEventsRequestEntry) SetDetailType(v string) *PutEventsRequestEntry

SetDetailType sets the DetailType field's value.

func (*PutEventsRequestEntry) SetEventBusName added in v1.99.0 

func (s *PutEventsRequestEntry) SetEventBusName(v string) *PutEventsRequestEntry

SetEventBusName sets the EventBusName field's value.

func (*PutEventsRequestEntry) SetResources added in v1.5.0 

func (s *PutEventsRequestEntry) SetResources(v []*string) *PutEventsRequestEntry

SetResources sets the Resources field's value.

func (*PutEventsRequestEntry) SetSource added in v1.5.0 

func (s *PutEventsRequestEntry) SetSource(v string) *PutEventsRequestEntry

SetSource sets the Source field's value.

func (*PutEventsRequestEntry) SetTime added in v1.5.0 

func (s *PutEventsRequestEntry) SetTime(v time.Time) *PutEventsRequestEntry

SetTime sets the Time field's value.

func (PutEventsRequestEntry) String 

func (s PutEventsRequestEntry) String() string

String returns the string representation

func (*PutEventsRequestEntry) Validate added in v1.99.0 

func (s *PutEventsRequestEntry) Validate() error

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

type PutEventsResultEntry 

type PutEventsResultEntry struct {

	// The error code that indicates why the event submission failed.
	ErrorCode *string `type:"string"`

	// The error message that explains why the event submission failed.
	ErrorMessage *string `type:"string"`

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

Represents an event that failed to be submitted.

func (PutEventsResultEntry) GoString 

func (s PutEventsResultEntry) GoString() string

GoString returns the string representation

func (*PutEventsResultEntry) SetErrorCode added in v1.5.0 

func (s *PutEventsResultEntry) SetErrorCode(v string) *PutEventsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutEventsResultEntry) SetErrorMessage added in v1.5.0 

func (s *PutEventsResultEntry) SetErrorMessage(v string) *PutEventsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutEventsResultEntry) SetEventId added in v1.5.0 

func (s *PutEventsResultEntry) SetEventId(v string) *PutEventsResultEntry

SetEventId sets the EventId field's value.

func (PutEventsResultEntry) String 

func (s PutEventsResultEntry) String() string

String returns the string representation

type PutPartnerEventsInput added in v1.99.0 

type PutPartnerEventsInput struct {

	// The list of events to write to the event bus.
	//
	// Entries is a required field
	Entries []*PutPartnerEventsRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutPartnerEventsInput) GoString added in v1.99.0 

func (s PutPartnerEventsInput) GoString() string

GoString returns the string representation

func (*PutPartnerEventsInput) SetEntries added in v1.99.0 

func (s *PutPartnerEventsInput) SetEntries(v []*PutPartnerEventsRequestEntry) *PutPartnerEventsInput

SetEntries sets the Entries field's value.

func (PutPartnerEventsInput) String added in v1.99.0 

func (s PutPartnerEventsInput) String() string

String returns the string representation

func (*PutPartnerEventsInput) Validate added in v1.99.0 

func (s *PutPartnerEventsInput) Validate() error

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

type PutPartnerEventsOutput added in v1.99.0 

type PutPartnerEventsOutput struct {

	// The list of events from this operation that were successfully written to
	// the partner event bus.
	Entries []*PutPartnerEventsResultEntry `type:"list"`

	// The number of events from this operation that couldn't be written to the
	// partner event bus.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (PutPartnerEventsOutput) GoString added in v1.99.0 

func (s PutPartnerEventsOutput) GoString() string

GoString returns the string representation

func (*PutPartnerEventsOutput) SetEntries added in v1.99.0 

func (s *PutPartnerEventsOutput) SetEntries(v []*PutPartnerEventsResultEntry) *PutPartnerEventsOutput

SetEntries sets the Entries field's value.

func (*PutPartnerEventsOutput) SetFailedEntryCount added in v1.99.0 

func (s *PutPartnerEventsOutput) SetFailedEntryCount(v int64) *PutPartnerEventsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (PutPartnerEventsOutput) String added in v1.99.0 

func (s PutPartnerEventsOutput) String() string

String returns the string representation

type PutPartnerEventsRequestEntry added in v1.99.0 

type PutPartnerEventsRequestEntry struct {

	// A valid JSON string. There is no other schema imposed. The JSON string can
	// contain fields and nested subobjects.
	Detail *string `type:"string"`

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

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

	// The event source that is generating the evntry.
	Source *string `type:"string"`

	// The date and time of the event.
	Time *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The details about an event generated by an SaaS partner.

func (PutPartnerEventsRequestEntry) GoString added in v1.99.0 

func (s PutPartnerEventsRequestEntry) GoString() string

GoString returns the string representation

func (*PutPartnerEventsRequestEntry) SetDetail added in v1.99.0 

func (s *PutPartnerEventsRequestEntry) SetDetail(v string) *PutPartnerEventsRequestEntry

SetDetail sets the Detail field's value.

func (*PutPartnerEventsRequestEntry) SetDetailType added in v1.99.0 

func (s *PutPartnerEventsRequestEntry) SetDetailType(v string) *PutPartnerEventsRequestEntry

SetDetailType sets the DetailType field's value.

func (*PutPartnerEventsRequestEntry) SetResources added in v1.99.0 

func (s *PutPartnerEventsRequestEntry) SetResources(v []*string) *PutPartnerEventsRequestEntry

SetResources sets the Resources field's value.

func (*PutPartnerEventsRequestEntry) SetSource added in v1.99.0 

func (s *PutPartnerEventsRequestEntry) SetSource(v string) *PutPartnerEventsRequestEntry

SetSource sets the Source field's value.

func (*PutPartnerEventsRequestEntry) SetTime added in v1.99.0 

func (s *PutPartnerEventsRequestEntry) SetTime(v time.Time) *PutPartnerEventsRequestEntry

SetTime sets the Time field's value.

func (PutPartnerEventsRequestEntry) String added in v1.99.0 

func (s PutPartnerEventsRequestEntry) String() string

String returns the string representation

type PutPartnerEventsResultEntry added in v1.99.0 

type PutPartnerEventsResultEntry struct {

	// The error code that indicates why the event submission failed.
	ErrorCode *string `type:"string"`

	// The error message that explains why the event submission failed.
	ErrorMessage *string `type:"string"`

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

Represents an event that a partner tried to generate but failed.

func (PutPartnerEventsResultEntry) GoString added in v1.99.0 

func (s PutPartnerEventsResultEntry) GoString() string

GoString returns the string representation

func (*PutPartnerEventsResultEntry) SetErrorCode added in v1.99.0 

func (s *PutPartnerEventsResultEntry) SetErrorCode(v string) *PutPartnerEventsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutPartnerEventsResultEntry) SetErrorMessage added in v1.99.0 

func (s *PutPartnerEventsResultEntry) SetErrorMessage(v string) *PutPartnerEventsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutPartnerEventsResultEntry) SetEventId added in v1.99.0 

func (s *PutPartnerEventsResultEntry) SetEventId(v string) *PutPartnerEventsResultEntry

SetEventId sets the EventId field's value.

func (PutPartnerEventsResultEntry) String added in v1.99.0 

func (s PutPartnerEventsResultEntry) String() string

String returns the string representation

type PutPermissionInput added in v1.10.5 

type PutPermissionInput struct {

	// The action that you're enabling the other account to perform. Currently,
	// this must be events:PutEvents.
	//
	// Action is a required field
	Action *string `min:"1" type:"string" required:"true"`

	// This parameter enables you to limit the permission to accounts that fulfill
	// a certain condition, such as being a member of a certain AWS organization.
	// For more information about AWS Organizations, see What Is AWS Organizations?
	// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html)
	// in the AWS Organizations User Guide.
	//
	// If you specify Condition with an AWS organization ID and specify "*" as the
	// value for Principal, you grant permission to all the accounts in the named
	// organization.
	//
	// The Condition is a JSON string that must contain Type, Key, and Value fields.
	Condition *Condition `type:"structure"`

	// The event bus associated with the rule. If you omit this, the default event
	// bus is used.
	EventBusName *string `min:"1" type:"string"`

	// The 12-digit AWS account ID that you are permitting to put events to your
	// default event bus. Specify "*" to permit any account to put events to your
	// default event bus.
	//
	// If you specify "*" without specifying Condition, avoid creating rules that
	// might match undesirable events. To create more secure rules, make sure that
	// the event pattern for each rule contains an account field with a specific
	// account ID to receive events from. Rules with an account field don't match
	// any events sent from other accounts.
	//
	// Principal is a required field
	Principal *string `min:"1" type:"string" required:"true"`

	// An identifier string for the external account that you're granting permissions
	// to. If you later want to revoke the permission for this external account,
	// specify this StatementId when you run RemovePermission.
	//
	// StatementId is a required field
	StatementId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutPermissionInput) GoString added in v1.10.5 

func (s PutPermissionInput) GoString() string

GoString returns the string representation

func (*PutPermissionInput) SetAction added in v1.10.5 

func (s *PutPermissionInput) SetAction(v string) *PutPermissionInput

SetAction sets the Action field's value.

func (*PutPermissionInput) SetCondition added in v1.99.0 

func (s *PutPermissionInput) SetCondition(v *Condition) *PutPermissionInput

SetCondition sets the Condition field's value.

func (*PutPermissionInput) SetEventBusName added in v1.99.0 

func (s *PutPermissionInput) SetEventBusName(v string) *PutPermissionInput

SetEventBusName sets the EventBusName field's value.

func (*PutPermissionInput) SetPrincipal added in v1.10.5 

func (s *PutPermissionInput) SetPrincipal(v string) *PutPermissionInput

SetPrincipal sets the Principal field's value.

func (*PutPermissionInput) SetStatementId added in v1.10.5 

func (s *PutPermissionInput) SetStatementId(v string) *PutPermissionInput

SetStatementId sets the StatementId field's value.

func (PutPermissionInput) String added in v1.10.5 

func (s PutPermissionInput) String() string

String returns the string representation

func (*PutPermissionInput) Validate added in v1.10.5 

func (s *PutPermissionInput) Validate() error

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

type PutPermissionOutput added in v1.10.5 

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

func (PutPermissionOutput) GoString added in v1.10.5 

func (s PutPermissionOutput) GoString() string

GoString returns the string representation

func (PutPermissionOutput) String added in v1.10.5 

func (s PutPermissionOutput) String() string

String returns the string representation

type PutRuleInput 

type PutRuleInput struct {

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

	// The event bus to associate with this rule. If you omit this, the default
	// event bus is used.
	EventBusName *string `min:"1" type:"string"`

	// The event pattern. For more information, see Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	EventPattern *string `type:"string"`

	// The name of the rule that you're creating or updating.
	//
	// Name is a required field
	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 * * ? *)" or "rate(5 minutes)".
	ScheduleExpression *string `type:"string"`

	// Indicates whether the rule is enabled or disabled.
	State *string `type:"string" enum:"RuleState"`

	// The list of key-value pairs to associate with the rule.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (PutRuleInput) GoString 

func (s PutRuleInput) GoString() string

GoString returns the string representation

func (*PutRuleInput) SetDescription added in v1.5.0 

func (s *PutRuleInput) SetDescription(v string) *PutRuleInput

SetDescription sets the Description field's value.

func (*PutRuleInput) SetEventBusName added in v1.99.0 

func (s *PutRuleInput) SetEventBusName(v string) *PutRuleInput

SetEventBusName sets the EventBusName field's value.

func (*PutRuleInput) SetEventPattern added in v1.5.0 

func (s *PutRuleInput) SetEventPattern(v string) *PutRuleInput

SetEventPattern sets the EventPattern field's value.

func (*PutRuleInput) SetName added in v1.5.0 

func (s *PutRuleInput) SetName(v string) *PutRuleInput

SetName sets the Name field's value.

func (*PutRuleInput) SetRoleArn added in v1.5.0 

func (s *PutRuleInput) SetRoleArn(v string) *PutRuleInput

SetRoleArn sets the RoleArn field's value.

func (*PutRuleInput) SetScheduleExpression added in v1.5.0 

func (s *PutRuleInput) SetScheduleExpression(v string) *PutRuleInput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*PutRuleInput) SetState added in v1.5.0 

func (s *PutRuleInput) SetState(v string) *PutRuleInput

SetState sets the State field's value.

func (*PutRuleInput) SetTags added in v1.99.0 

func (s *PutRuleInput) SetTags(v []*Tag) *PutRuleInput

SetTags sets the Tags field's value.

func (PutRuleInput) String 

func (s PutRuleInput) String() string

String returns the string representation

func (*PutRuleInput) Validate added in v1.1.21 

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) of the rule.
	RuleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutRuleOutput) GoString 

func (s PutRuleOutput) GoString() string

GoString returns the string representation

func (*PutRuleOutput) SetRuleArn added in v1.5.0 

func (s *PutRuleOutput) SetRuleArn(v string) *PutRuleOutput

SetRuleArn sets the RuleArn field's value.

func (PutRuleOutput) String 

func (s PutRuleOutput) String() string

String returns the string representation

type PutTargetsInput 

type PutTargetsInput struct {

	// The name of the event bus associated with the rule. If you omit this, the
	// default event bus is used.
	EventBusName *string `min:"1" type:"string"`

	// The name of the rule.
	//
	// Rule is a required field
	Rule *string `min:"1" type:"string" required:"true"`

	// The targets to update or add to the rule.
	//
	// Targets is a required field
	Targets []*Target `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutTargetsInput) GoString 

func (s PutTargetsInput) GoString() string

GoString returns the string representation

func (*PutTargetsInput) SetEventBusName added in v1.99.0 

func (s *PutTargetsInput) SetEventBusName(v string) *PutTargetsInput

SetEventBusName sets the EventBusName field's value.

func (*PutTargetsInput) SetRule added in v1.5.0 

func (s *PutTargetsInput) SetRule(v string) *PutTargetsInput

SetRule sets the Rule field's value.

func (*PutTargetsInput) SetTargets added in v1.5.0 

func (s *PutTargetsInput) SetTargets(v []*Target) *PutTargetsInput

SetTargets sets the Targets field's value.

func (PutTargetsInput) String 

func (s PutTargetsInput) String() string

String returns the string representation

func (*PutTargetsInput) Validate added in v1.1.21 

func (s *PutTargetsInput) Validate() error

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

type PutTargetsOutput 

type PutTargetsOutput struct {

	// The failed target entries.
	FailedEntries []*PutTargetsResultEntry `type:"list"`

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

func (PutTargetsOutput) GoString 

func (s PutTargetsOutput) GoString() string

GoString returns the string representation

func (*PutTargetsOutput) SetFailedEntries added in v1.5.0 

func (s *PutTargetsOutput) SetFailedEntries(v []*PutTargetsResultEntry) *PutTargetsOutput

SetFailedEntries sets the FailedEntries field's value.

func (*PutTargetsOutput) SetFailedEntryCount added in v1.5.0 

func (s *PutTargetsOutput) SetFailedEntryCount(v int64) *PutTargetsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (PutTargetsOutput) String 

func (s PutTargetsOutput) String() string

String returns the string representation

type PutTargetsResultEntry 

type PutTargetsResultEntry struct {

	// The error code that indicates why the target addition failed. If the value
	// is ConcurrentModificationException, too many requests were made at the same
	// time.
	ErrorCode *string `type:"string"`

	// The error message that explains why the target addition failed.
	ErrorMessage *string `type:"string"`

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

Represents a target that failed to be added to a rule.

func (PutTargetsResultEntry) GoString 

func (s PutTargetsResultEntry) GoString() string

GoString returns the string representation

func (*PutTargetsResultEntry) SetErrorCode added in v1.5.0 

func (s *PutTargetsResultEntry) SetErrorCode(v string) *PutTargetsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutTargetsResultEntry) SetErrorMessage added in v1.5.0 

func (s *PutTargetsResultEntry) SetErrorMessage(v string) *PutTargetsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutTargetsResultEntry) SetTargetId added in v1.5.0 

func (s *PutTargetsResultEntry) SetTargetId(v string) *PutTargetsResultEntry

SetTargetId sets the TargetId field's value.

func (PutTargetsResultEntry) String 

func (s PutTargetsResultEntry) String() string

String returns the string representation

type RemovePermissionInput added in v1.10.5 

type RemovePermissionInput struct {

	// The name of the event bus to revoke permissions for. If you omit this, the
	// default event bus is used.
	EventBusName *string `min:"1" type:"string"`

	// The statement ID corresponding to the account that is no longer allowed to
	// put events to the default event bus.
	//
	// StatementId is a required field
	StatementId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemovePermissionInput) GoString added in v1.10.5 

func (s RemovePermissionInput) GoString() string

GoString returns the string representation

func (*RemovePermissionInput) SetEventBusName added in v1.99.0 

func (s *RemovePermissionInput) SetEventBusName(v string) *RemovePermissionInput

SetEventBusName sets the EventBusName field's value.

func (*RemovePermissionInput) SetStatementId added in v1.10.5 

func (s *RemovePermissionInput) SetStatementId(v string) *RemovePermissionInput

SetStatementId sets the StatementId field's value.

func (RemovePermissionInput) String added in v1.10.5 

func (s RemovePermissionInput) String() string

String returns the string representation

func (*RemovePermissionInput) Validate added in v1.10.5 

func (s *RemovePermissionInput) Validate() error

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

type RemovePermissionOutput added in v1.10.5 

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

func (RemovePermissionOutput) GoString added in v1.10.5 

func (s RemovePermissionOutput) GoString() string

GoString returns the string representation

func (RemovePermissionOutput) String added in v1.10.5 

func (s RemovePermissionOutput) String() string

String returns the string representation

type RemoveTargetsInput 

type RemoveTargetsInput struct {

	// The name of the event bus associated with the rule.
	EventBusName *string `min:"1" type:"string"`

	// If this is a managed rule created by an AWS service on your behalf, you must
	// specify Force as True to remove targets. This parameter is ignored for rules
	// that aren't managed rules. You can check whether a rule is a managed rule
	// by using DescribeRule or ListRules and checking the ManagedBy field of the
	// response.
	Force *bool `type:"boolean"`

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

	// The name of the rule.
	//
	// Rule is a required field
	Rule *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTargetsInput) GoString 

func (s RemoveTargetsInput) GoString() string

GoString returns the string representation

func (*RemoveTargetsInput) SetEventBusName added in v1.99.0 

func (s *RemoveTargetsInput) SetEventBusName(v string) *RemoveTargetsInput

SetEventBusName sets the EventBusName field's value.

func (*RemoveTargetsInput) SetForce added in v1.99.0 

func (s *RemoveTargetsInput) SetForce(v bool) *RemoveTargetsInput

SetForce sets the Force field's value.

func (*RemoveTargetsInput) SetIds added in v1.5.0 

func (s *RemoveTargetsInput) SetIds(v []*string) *RemoveTargetsInput

SetIds sets the Ids field's value.

func (*RemoveTargetsInput) SetRule added in v1.5.0 

func (s *RemoveTargetsInput) SetRule(v string) *RemoveTargetsInput

SetRule sets the Rule field's value.

func (RemoveTargetsInput) String 

func (s RemoveTargetsInput) String() string

String returns the string representation

func (*RemoveTargetsInput) Validate added in v1.1.21 

func (s *RemoveTargetsInput) Validate() error

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

type RemoveTargetsOutput 

type RemoveTargetsOutput struct {

	// The failed target entries.
	FailedEntries []*RemoveTargetsResultEntry `type:"list"`

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

func (RemoveTargetsOutput) GoString 

func (s RemoveTargetsOutput) GoString() string

GoString returns the string representation

func (*RemoveTargetsOutput) SetFailedEntries added in v1.5.0 

func (s *RemoveTargetsOutput) SetFailedEntries(v []*RemoveTargetsResultEntry) *RemoveTargetsOutput

SetFailedEntries sets the FailedEntries field's value.

func (*RemoveTargetsOutput) SetFailedEntryCount added in v1.5.0 

func (s *RemoveTargetsOutput) SetFailedEntryCount(v int64) *RemoveTargetsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (RemoveTargetsOutput) String 

func (s RemoveTargetsOutput) String() string

String returns the string representation

type RemoveTargetsResultEntry 

type RemoveTargetsResultEntry struct {

	// The error code that indicates why the target removal failed. If the value
	// is ConcurrentModificationException, too many requests were made at the same
	// time.
	ErrorCode *string `type:"string"`

	// The error message that explains why the target removal failed.
	ErrorMessage *string `type:"string"`

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

Represents a target that failed to be removed from a rule.

func (RemoveTargetsResultEntry) GoString 

func (s RemoveTargetsResultEntry) GoString() string

GoString returns the string representation

func (*RemoveTargetsResultEntry) SetErrorCode added in v1.5.0 

func (s *RemoveTargetsResultEntry) SetErrorCode(v string) *RemoveTargetsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*RemoveTargetsResultEntry) SetErrorMessage added in v1.5.0 

func (s *RemoveTargetsResultEntry) SetErrorMessage(v string) *RemoveTargetsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*RemoveTargetsResultEntry) SetTargetId added in v1.5.0 

func (s *RemoveTargetsResultEntry) SetTargetId(v string) *RemoveTargetsResultEntry

SetTargetId sets the TargetId field's value.

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 bus associated with the rule.
	EventBusName *string `min:"1" type:"string"`

	// The event pattern of the rule. For more information, see Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	EventPattern *string `type:"string"`

	// If an AWS service created the rule on behalf of your account, this field
	// displays the principal name of the service that created the rule.
	ManagedBy *string `min:"1" type:"string"`

	// The name of the rule.
	Name *string `min:"1" type:"string"`

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

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

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

Contains information about a rule in Amazon EventBridge.

func (Rule) GoString 

func (s Rule) GoString() string

GoString returns the string representation

func (*Rule) SetArn added in v1.5.0 

func (s *Rule) SetArn(v string) *Rule

SetArn sets the Arn field's value.

func (*Rule) SetDescription added in v1.5.0 

func (s *Rule) SetDescription(v string) *Rule

SetDescription sets the Description field's value.

func (*Rule) SetEventBusName added in v1.99.0 

func (s *Rule) SetEventBusName(v string) *Rule

SetEventBusName sets the EventBusName field's value.

func (*Rule) SetEventPattern added in v1.5.0 

func (s *Rule) SetEventPattern(v string) *Rule

SetEventPattern sets the EventPattern field's value.

func (*Rule) SetManagedBy added in v1.99.0 

func (s *Rule) SetManagedBy(v string) *Rule

SetManagedBy sets the ManagedBy field's value.

func (*Rule) SetName added in v1.5.0 

func (s *Rule) SetName(v string) *Rule

SetName sets the Name field's value.

func (*Rule) SetRoleArn added in v1.5.0 

func (s *Rule) SetRoleArn(v string) *Rule

SetRoleArn sets the RoleArn field's value.

func (*Rule) SetScheduleExpression added in v1.5.0 

func (s *Rule) SetScheduleExpression(v string) *Rule

SetScheduleExpression sets the ScheduleExpression field's value.

func (*Rule) SetState added in v1.5.0 

func (s *Rule) SetState(v string) *Rule

SetState sets the State field's value.

func (Rule) String 

func (s Rule) String() string

String returns the string representation

type RunCommandParameters added in v1.7.9 

type RunCommandParameters struct {

	// Currently, we support including only one RunCommandTarget block, which specifies
	// either an array of InstanceIds or a tag.
	//
	// RunCommandTargets is a required field
	RunCommandTargets []*RunCommandTarget `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

func (RunCommandParameters) GoString added in v1.7.9 

func (s RunCommandParameters) GoString() string

GoString returns the string representation

func (*RunCommandParameters) SetRunCommandTargets added in v1.7.9 

func (s *RunCommandParameters) SetRunCommandTargets(v []*RunCommandTarget) *RunCommandParameters

SetRunCommandTargets sets the RunCommandTargets field's value.

func (RunCommandParameters) String added in v1.7.9 

func (s RunCommandParameters) String() string

String returns the string representation

func (*RunCommandParameters) Validate added in v1.7.9 

func (s *RunCommandParameters) Validate() error

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

type RunCommandTarget added in v1.7.9 

type RunCommandTarget struct {

	// Can be either tag: tag-key or InstanceIds.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds,
	// Values is a list of Amazon EC2 instance IDs.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key can specify multiple values.

func (RunCommandTarget) GoString added in v1.7.9 

func (s RunCommandTarget) GoString() string

GoString returns the string representation

func (*RunCommandTarget) SetKey added in v1.7.9 

func (s *RunCommandTarget) SetKey(v string) *RunCommandTarget

SetKey sets the Key field's value.

func (*RunCommandTarget) SetValues added in v1.7.9 

func (s *RunCommandTarget) SetValues(v []*string) *RunCommandTarget

SetValues sets the Values field's value.

func (RunCommandTarget) String added in v1.7.9 

func (s RunCommandTarget) String() string

String returns the string representation

func (*RunCommandTarget) Validate added in v1.7.9 

func (s *RunCommandTarget) Validate() error

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

type SqsParameters added in v1.13.17 

type SqsParameters struct {

	// The FIFO message group ID to use as the target.
	MessageGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

This structure includes the custom parameter to be used when the target is an SQS FIFO queue.

func (SqsParameters) GoString added in v1.13.17 

func (s SqsParameters) GoString() string

GoString returns the string representation

func (*SqsParameters) SetMessageGroupId added in v1.13.17 

func (s *SqsParameters) SetMessageGroupId(v string) *SqsParameters

SetMessageGroupId sets the MessageGroupId field's value.

func (SqsParameters) String added in v1.13.17 

func (s SqsParameters) String() string

String returns the string representation

type Tag added in v1.99.0 

type Tag struct {

	// A string that you can use to assign a value. The combination of tag keys
	// and values can help you organize and categorize your resources.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value for the specified tag key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A key-value pair associated with an AWS resource. In EventBridge, rules support tagging.

func (Tag) GoString added in v1.99.0 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.99.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.99.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.99.0 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.99.0 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.99.0 

type TagResourceInput struct {

	// The ARN of the rule that you're adding tags to.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The list of key-value pairs to associate with the rule.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.99.0 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN added in v1.99.0 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.99.0 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.99.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.99.0 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.99.0 

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

func (TagResourceOutput) GoString added in v1.99.0 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.99.0 

func (s TagResourceOutput) String() string

String returns the string representation

type Target 

type Target struct {

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

	// If the event target is an AWS Batch job, this contains the job definition,
	// job name, and other parameters. For more information, see Jobs (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html)
	// in the AWS Batch User Guide.
	BatchParameters *BatchParameters `type:"structure"`

	// Contains the Amazon ECS task definition and task count to be used if the
	// event target is an Amazon ECS task. For more information about Amazon ECS
	// tasks, see Task Definitions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html)
	// in the Amazon EC2 Container Service Developer Guide.
	EcsParameters *EcsParameters `type:"structure"`

	// The ID of the target.
	//
	// Id is a required field
	Id *string `min:"1" type:"string" required:"true"`

	// Valid JSON text passed to the target. In this case, nothing from the event
	// itself is passed to the target. For more information, 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. You must use JSON dot notation, not
	// bracket notation. For more information about JSON paths, see JSONPath (http://goessner.net/articles/JsonPath/).
	InputPath *string `type:"string"`

	// Settings to enable you to provide custom input to a target based on certain
	// event data. You can extract one or more key-value pairs from the event and
	// then use that data to send customized input to the target.
	InputTransformer *InputTransformer `type:"structure"`

	// The custom parameter that you can use to control the shard assignment when
	// the target is a Kinesis data stream. If you don't include this parameter,
	// the default is to use the eventId as the partition key.
	KinesisParameters *KinesisParameters `type:"structure"`

	// The Amazon Resource Name (ARN) of the IAM role to be used for this target
	// when the rule is triggered. If one rule triggers multiple targets, you can
	// use a different IAM role for each target.
	RoleArn *string `min:"1" type:"string"`

	// Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
	RunCommandParameters *RunCommandParameters `type:"structure"`

	// Contains the message group ID to use when the target is a FIFO queue.
	//
	// If you specify an SQS FIFO queue as a target, the queue must have content-based
	// deduplication enabled.
	SqsParameters *SqsParameters `type:"structure"`
	// contains filtered or unexported fields
}

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you're setting the event bus of another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the Amazon EventBridge User Guide.

func (Target) GoString 

func (s Target) GoString() string

GoString returns the string representation

func (*Target) SetArn added in v1.5.0 

func (s *Target) SetArn(v string) *Target

SetArn sets the Arn field's value.

func (*Target) SetBatchParameters added in v1.13.8 

func (s *Target) SetBatchParameters(v *BatchParameters) *Target

SetBatchParameters sets the BatchParameters field's value.

func (*Target) SetEcsParameters added in v1.7.9 

func (s *Target) SetEcsParameters(v *EcsParameters) *Target

SetEcsParameters sets the EcsParameters field's value.

func (*Target) SetId added in v1.5.0 

func (s *Target) SetId(v string) *Target

SetId sets the Id field's value.

func (*Target) SetInput added in v1.5.0 

func (s *Target) SetInput(v string) *Target

SetInput sets the Input field's value.

func (*Target) SetInputPath added in v1.5.0 

func (s *Target) SetInputPath(v string) *Target

SetInputPath sets the InputPath field's value.

func (*Target) SetInputTransformer added in v1.7.9 

func (s *Target) SetInputTransformer(v *InputTransformer) *Target

SetInputTransformer sets the InputTransformer field's value.

func (*Target) SetKinesisParameters added in v1.7.9 

func (s *Target) SetKinesisParameters(v *KinesisParameters) *Target

SetKinesisParameters sets the KinesisParameters field's value.

func (*Target) SetRoleArn added in v1.7.9 

func (s *Target) SetRoleArn(v string) *Target

SetRoleArn sets the RoleArn field's value.

func (*Target) SetRunCommandParameters added in v1.7.9 

func (s *Target) SetRunCommandParameters(v *RunCommandParameters) *Target

SetRunCommandParameters sets the RunCommandParameters field's value.

func (*Target) SetSqsParameters added in v1.13.17 

func (s *Target) SetSqsParameters(v *SqsParameters) *Target

SetSqsParameters sets the SqsParameters field's value.

func (Target) String 

func (s Target) String() string

String returns the string representation

func (*Target) Validate added in v1.1.21 

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 JSON format, to test against the event pattern.
	//
	// Event is a required field
	Event *string `type:"string" required:"true"`

	// The event pattern. For more information, see Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	//
	// EventPattern is a required field
	EventPattern *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TestEventPatternInput) GoString 

func (s TestEventPatternInput) GoString() string

GoString returns the string representation

func (*TestEventPatternInput) SetEvent added in v1.5.0 

func (s *TestEventPatternInput) SetEvent(v string) *TestEventPatternInput

SetEvent sets the Event field's value.

func (*TestEventPatternInput) SetEventPattern added in v1.5.0 

func (s *TestEventPatternInput) SetEventPattern(v string) *TestEventPatternInput

SetEventPattern sets the EventPattern field's value.

func (TestEventPatternInput) String 

func (s TestEventPatternInput) String() string

String returns the string representation

func (*TestEventPatternInput) Validate added in v1.1.21 

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
}

func (TestEventPatternOutput) GoString 

func (s TestEventPatternOutput) GoString() string

GoString returns the string representation

func (*TestEventPatternOutput) SetResult added in v1.5.0 

func (s *TestEventPatternOutput) SetResult(v bool) *TestEventPatternOutput

SetResult sets the Result field's value.

func (TestEventPatternOutput) String 

func (s TestEventPatternOutput) String() string

String returns the string representation

type UntagResourceInput added in v1.99.0 

type UntagResourceInput struct {

	// The ARN of the rule that you're removing tags from.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The list of tag keys to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.99.0 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN added in v1.99.0 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.99.0 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.99.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.99.0 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.99.0 

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

func (UntagResourceOutput) GoString added in v1.99.0 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.99.0 

func (s UntagResourceOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package cloudwatcheventsiface provides an interface to enable mocking the Amazon CloudWatch Events service client for testing your code.
 Package cloudwatcheventsiface provides an interface to enable mocking the Amazon CloudWatch Events service client for testing your code.

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.