...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/cloudwatchevents"
Overview
Constants

Overview ▾

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

Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a pre-determined schedule. For example, you can configure rules to:

* Automatically invoke an AWS Lambda function to update DNS entries when
an event notifies you that Amazon EC2 instance enters the running state.

* Direct specific API records from CloudTrail to an Amazon Kinesis stream
for detailed analysis of potential security or availability risks.

* Periodically invoke a built-in target to create a snapshot of an Amazon
EBS volume.

For more information about the features of Amazon CloudWatch Events, see the Amazon CloudWatch Events User Guide (http://docs.aws.amazon.com/AmazonCloudWatch/latest/events).

See https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07 for more information on this service.

See cloudwatchevents package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchevents/

Using the Client

To 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

The stub package, cloudwatcheventsiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type BatchArrayProperties
func (s *BatchArrayProperties) SetSize(v int64) *BatchArrayProperties
type BatchParameters
func (s *BatchParameters) SetArrayProperties(v *BatchArrayProperties) *BatchParameters
func (s *BatchParameters) SetJobDefinition(v string) *BatchParameters
func (s *BatchParameters) SetJobName(v string) *BatchParameters
func (s *BatchParameters) SetRetryStrategy(v *BatchRetryStrategy) *BatchParameters
type BatchRetryStrategy
func (s *BatchRetryStrategy) SetAttempts(v int64) *BatchRetryStrategy
type CloudWatchEvents
type DeleteRuleInput
func (s *DeleteRuleInput) SetName(v string) *DeleteRuleInput
type DeleteRuleOutput
type DescribeEventBusInput
type DescribeEventBusOutput
func (s *DescribeEventBusOutput) SetArn(v string) *DescribeEventBusOutput
func (s *DescribeEventBusOutput) SetName(v string) *DescribeEventBusOutput
func (s *DescribeEventBusOutput) SetPolicy(v string) *DescribeEventBusOutput
type DescribeRuleInput
func (s *DescribeRuleInput) SetName(v string) *DescribeRuleInput
type DescribeRuleOutput
func (s *DescribeRuleOutput) SetArn(v string) *DescribeRuleOutput
func (s *DescribeRuleOutput) SetDescription(v string) *DescribeRuleOutput
func (s *DescribeRuleOutput) SetEventPattern(v string) *DescribeRuleOutput
func (s *DescribeRuleOutput) SetName(v string) *DescribeRuleOutput
func (s *DescribeRuleOutput) SetRoleArn(v string) *DescribeRuleOutput
func (s *DescribeRuleOutput) SetScheduleExpression(v string) *DescribeRuleOutput
func (s *DescribeRuleOutput) SetState(v string) *DescribeRuleOutput
type DisableRuleInput
func (s *DisableRuleInput) SetName(v string) *DisableRuleInput
type DisableRuleOutput
type EcsParameters
func (s *EcsParameters) SetTaskCount(v int64) *EcsParameters
func (s *EcsParameters) SetTaskDefinitionArn(v string) *EcsParameters
type EnableRuleInput
func (s *EnableRuleInput) SetName(v string) *EnableRuleInput
type EnableRuleOutput
type InputTransformer
func (s *InputTransformer) SetInputPathsMap(v map[string]*string) *InputTransformer
func (s *InputTransformer) SetInputTemplate(v string) *InputTransformer
type KinesisParameters
func (s *KinesisParameters) SetPartitionKeyPath(v string) *KinesisParameters
type ListRuleNamesByTargetInput
func (s *ListRuleNamesByTargetInput) SetLimit(v int64) *ListRuleNamesByTargetInput
func (s *ListRuleNamesByTargetInput) SetNextToken(v string) *ListRuleNamesByTargetInput
func (s *ListRuleNamesByTargetInput) SetTargetArn(v string) *ListRuleNamesByTargetInput
type ListRuleNamesByTargetOutput
func (s *ListRuleNamesByTargetOutput) SetNextToken(v string) *ListRuleNamesByTargetOutput
func (s *ListRuleNamesByTargetOutput) SetRuleNames(v []*string) *ListRuleNamesByTargetOutput
type ListRulesInput
func (s *ListRulesInput) SetLimit(v int64) *ListRulesInput
func (s *ListRulesInput) SetNamePrefix(v string) *ListRulesInput
func (s *ListRulesInput) SetNextToken(v string) *ListRulesInput
type ListRulesOutput
func (s *ListRulesOutput) SetNextToken(v string) *ListRulesOutput
func (s *ListRulesOutput) SetRules(v []*Rule) *ListRulesOutput
type ListTargetsByRuleInput
func (s *ListTargetsByRuleInput) SetLimit(v int64) *ListTargetsByRuleInput
func (s *ListTargetsByRuleInput) SetNextToken(v string) *ListTargetsByRuleInput
func (s *ListTargetsByRuleInput) SetRule(v string) *ListTargetsByRuleInput
type ListTargetsByRuleOutput
func (s *ListTargetsByRuleOutput) SetNextToken(v string) *ListTargetsByRuleOutput
func (s *ListTargetsByRuleOutput) SetTargets(v []*Target) *ListTargetsByRuleOutput
type PutEventsInput
func (s *PutEventsInput) SetEntries(v []*PutEventsRequestEntry) *PutEventsInput
type PutEventsOutput
func (s *PutEventsOutput) SetEntries(v []*PutEventsResultEntry) *PutEventsOutput
func (s *PutEventsOutput) SetFailedEntryCount(v int64) *PutEventsOutput
type PutEventsRequestEntry
func (s *PutEventsRequestEntry) SetDetail(v string) *PutEventsRequestEntry
func (s *PutEventsRequestEntry) SetDetailType(v string) *PutEventsRequestEntry
func (s *PutEventsRequestEntry) SetResources(v []*string) *PutEventsRequestEntry
func (s *PutEventsRequestEntry) SetSource(v string) *PutEventsRequestEntry
func (s *PutEventsRequestEntry) SetTime(v time.Time) *PutEventsRequestEntry
type PutEventsResultEntry
func (s *PutEventsResultEntry) SetErrorCode(v string) *PutEventsResultEntry
func (s *PutEventsResultEntry) SetErrorMessage(v string) *PutEventsResultEntry
func (s *PutEventsResultEntry) SetEventId(v string) *PutEventsResultEntry
type PutPermissionInput
func (s *PutPermissionInput) SetAction(v string) *PutPermissionInput
func (s *PutPermissionInput) SetPrincipal(v string) *PutPermissionInput
func (s *PutPermissionInput) SetStatementId(v string) *PutPermissionInput
type PutPermissionOutput
type PutRuleInput
func (s *PutRuleInput) SetDescription(v string) *PutRuleInput
func (s *PutRuleInput) SetEventPattern(v string) *PutRuleInput
func (s *PutRuleInput) SetName(v string) *PutRuleInput
func (s *PutRuleInput) SetRoleArn(v string) *PutRuleInput
func (s *PutRuleInput) SetScheduleExpression(v string) *PutRuleInput
func (s *PutRuleInput) SetState(v string) *PutRuleInput
type PutRuleOutput
func (s *PutRuleOutput) SetRuleArn(v string) *PutRuleOutput
type PutTargetsInput
func (s *PutTargetsInput) SetRule(v string) *PutTargetsInput
func (s *PutTargetsInput) SetTargets(v []*Target) *PutTargetsInput
type PutTargetsOutput
func (s *PutTargetsOutput) SetFailedEntries(v []*PutTargetsResultEntry) *PutTargetsOutput
func (s *PutTargetsOutput) SetFailedEntryCount(v int64) *PutTargetsOutput
type PutTargetsResultEntry
func (s *PutTargetsResultEntry) SetErrorCode(v string) *PutTargetsResultEntry
func (s *PutTargetsResultEntry) SetErrorMessage(v string) *PutTargetsResultEntry
func (s *PutTargetsResultEntry) SetTargetId(v string) *PutTargetsResultEntry
type RemovePermissionInput
func (s *RemovePermissionInput) SetStatementId(v string) *RemovePermissionInput
type RemovePermissionOutput
type RemoveTargetsInput
func (s *RemoveTargetsInput) SetIds(v []*string) *RemoveTargetsInput
func (s *RemoveTargetsInput) SetRule(v string) *RemoveTargetsInput
type RemoveTargetsOutput
func (s *RemoveTargetsOutput) SetFailedEntries(v []*RemoveTargetsResultEntry) *RemoveTargetsOutput
func (s *RemoveTargetsOutput) SetFailedEntryCount(v int64) *RemoveTargetsOutput
type RemoveTargetsResultEntry
func (s *RemoveTargetsResultEntry) SetErrorCode(v string) *RemoveTargetsResultEntry
func (s *RemoveTargetsResultEntry) SetErrorMessage(v string) *RemoveTargetsResultEntry
func (s *RemoveTargetsResultEntry) SetTargetId(v string) *RemoveTargetsResultEntry
type Rule
func (s *Rule) SetArn(v string) *Rule
func (s *Rule) SetDescription(v string) *Rule
func (s *Rule) SetEventPattern(v string) *Rule
func (s *Rule) SetName(v string) *Rule
func (s *Rule) SetRoleArn(v string) *Rule
func (s *Rule) SetScheduleExpression(v string) *Rule
func (s *Rule) SetState(v string) *Rule
type RunCommandParameters
func (s *RunCommandParameters) SetRunCommandTargets(v []*RunCommandTarget) *RunCommandParameters
type RunCommandTarget
func (s *RunCommandTarget) SetKey(v string) *RunCommandTarget
func (s *RunCommandTarget) SetValues(v []*string) *RunCommandTarget
type SqsParameters
func (s *SqsParameters) SetMessageGroupId(v string) *SqsParameters
type Target
func (s *Target) SetArn(v string) *Target
func (s *Target) SetBatchParameters(v *BatchParameters) *Target
func (s *Target) SetEcsParameters(v *EcsParameters) *Target
func (s *Target) SetId(v string) *Target
func (s *Target) SetInput(v string) *Target
func (s *Target) SetInputPath(v string) *Target
func (s *Target) SetInputTransformer(v *InputTransformer) *Target
func (s *Target) SetKinesisParameters(v *KinesisParameters) *Target
func (s *Target) SetRoleArn(v string) *Target
func (s *Target) SetRunCommandParameters(v *RunCommandParameters) *Target
func (s *Target) SetSqsParameters(v *SqsParameters) *Target
type TestEventPatternInput
func (s *TestEventPatternInput) SetEvent(v string) *TestEventPatternInput
func (s *TestEventPatternInput) SetEventPattern(v string) *TestEventPatternInput
type TestEventPatternOutput
func (s *TestEventPatternOutput) SetResult(v bool) *TestEventPatternOutput

Constants ▾

const (
    // RuleStateEnabled is a RuleState enum value
    RuleStateEnabled = "ENABLED"

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

    // ErrCodeConcurrentModificationException for service response error code
    // "ConcurrentModificationException".
    //
    // There is concurrent modification on a rule or target.
    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 is not valid.
    ErrCodeInvalidEventPatternException = "InvalidEventPatternException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // You tried to create more rules or add more targets to a rule than is allowed.
    ErrCodeLimitExceededException = "LimitExceededException"

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

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // An entity that you specified does not exist.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)
const (
    ServiceName = "events"    // Service endpoint prefix API calls made to.
    EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

type BatchArrayProperties

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

func (s BatchArrayProperties) GoString() string

GoString returns the string representation

func (*BatchArrayProperties) SetSize

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

SetSize sets the Size field's value.

func (BatchArrayProperties) String

func (s BatchArrayProperties) String() string

String returns the string representation

type BatchParameters

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 to 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

func (s BatchParameters) GoString() string

GoString returns the string representation

func (*BatchParameters) SetArrayProperties

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

SetArrayProperties sets the ArrayProperties field's value.

func (*BatchParameters) SetJobDefinition

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

SetJobDefinition sets the JobDefinition field's value.

func (*BatchParameters) SetJobName

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

SetJobName sets the JobName field's value.

func (*BatchParameters) SetRetryStrategy

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

SetRetryStrategy sets the RetryStrategy field's value.

func (BatchParameters) String

func (s BatchParameters) String() string

String returns the string representation

func (*BatchParameters) Validate

func (s *BatchParameters) Validate() error

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

type BatchRetryStrategy

type BatchRetryStrategy struct {

    // The number of times to attempt to retry, if the job fails. Valid values are
    // 1 to 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

func (s BatchRetryStrategy) GoString() string

GoString returns the string representation

func (*BatchRetryStrategy) SetAttempts

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

SetAttempts sets the Attempts field's value.

func (BatchRetryStrategy) String

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) DeleteRule

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

DeleteRule API operation for Amazon CloudWatch Events.

Deletes the specified rule.

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

When you delete a rule, incoming events might continue to match to the deleted rule. Please 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 DeleteRule for usage and error information.

Returned Error Codes:

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
There is concurrent modification on a rule or target.

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

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 successfuly.

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

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

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

DescribeEventBus API operation for Amazon CloudWatch Events.

Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy. To enable your account to receive events from other accounts, use PutPermission.

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 does not 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

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 successfuly.

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

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) DescribeRule

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

DescribeRule API operation for Amazon CloudWatch Events.

Describes 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 DescribeRule for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
An entity that you specified does not 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 successfuly.

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

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. Please 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 does not exist.

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
There is concurrent modification on a rule or target.

* 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 successfuly.

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

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 does not exist, the operation fails.

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

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 does not exist.

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
There is concurrent modification on a rule or target.

* 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 successfuly.

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

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) 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 of the rules in Amazon CloudWatch Events 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.

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 successfuly.

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

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 Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names.

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.

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 successfuly.

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

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) 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 does not 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 successfuly.

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

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 Amazon CloudWatch Events so that they can be matched to rules.

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 successfuly.

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

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) PutPermission

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

PutPermission API operation for Amazon CloudWatch Events.

Running PutPermission permits the specified AWS account to put events to your account's default event bus. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus.

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

To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts.

The permission policy on the default event bus cannot exceed 10KB 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 does not 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 rule or target.

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

func (*CloudWatchEvents) PutPermissionRequest

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 successfuly.

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

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.

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

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.

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

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

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 is not valid.

* ErrCodeLimitExceededException "LimitExceededException"
You tried to create more rules or add more targets to a rule than is allowed.

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
There is concurrent modification on a rule or target.

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

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 successfuly.

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

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 are already associated with the rule.

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

You can configure the following as targets for CloudWatch Events:

* EC2 instances

* AWS Lambda functions

* Streams in Amazon Kinesis Streams

* Delivery streams in Amazon Kinesis Firehose

* Amazon ECS tasks

* AWS Step Functions state machines

* AWS Batch jobs

* Pipelines in Amazon Code Pipeline

* Amazon Inspector assessment templates

* Amazon SNS topics

* Amazon SQS queues, including FIFO queues

* The default event bus of another AWS account

Note that creating rules with built-in targets is supported only in the AWS Management Console.

For some target types, PutTargets provides target-specific parameters. If the target is an Amazon Kinesis 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 CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control (http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/auth-and-access-control-cwe.html) in the Amazon CloudWatch Events 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 by setting 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 when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).

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, then
the entire event is passed to the target in JSON form (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),
then 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, then 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. Please 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 PutTargets for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
An entity that you specified does not exist.

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
There is concurrent modification on a rule or target.

* ErrCodeLimitExceededException "LimitExceededException"
You tried to create more rules or add more targets to a rule than is allowed.

* 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 successfuly.

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

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

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 your default 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 does not exist.

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

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
There is concurrent modification on a rule or target.

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

func (*CloudWatchEvents) RemovePermissionRequest

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 successfuly.

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

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. Please 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 does not exist.

* ErrCodeConcurrentModificationException "ConcurrentModificationException"
There is concurrent modification on a rule or target.

* 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 successfuly.

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

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) 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, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

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 is not 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 successfuly.

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

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.

type DeleteRuleInput

type DeleteRuleInput struct {

    // 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) SetName

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

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

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

func (DescribeEventBusInput) GoString

func (s DescribeEventBusInput) GoString() string

GoString returns the string representation

func (DescribeEventBusInput) String

func (s DescribeEventBusInput) String() string

String returns the string representation

type DescribeEventBusOutput

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

func (s DescribeEventBusOutput) GoString() string

GoString returns the string representation

func (*DescribeEventBusOutput) SetArn

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

SetArn sets the Arn field's value.

func (*DescribeEventBusOutput) SetName

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

SetName sets the Name field's value.

func (*DescribeEventBusOutput) SetPolicy

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

SetPolicy sets the Policy field's value.

func (DescribeEventBusOutput) String

func (s DescribeEventBusOutput) String() string

String returns the string representation

type DescribeRuleInput

type DescribeRuleInput struct {

    // 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) SetName

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

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 pattern. For more information, see Events and Event Patterns (http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html)
    // in the Amazon CloudWatch Events User Guide.
    EventPattern *string `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 * * ? *)", "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

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

SetArn sets the Arn field's value.

func (*DescribeRuleOutput) SetDescription

func (s *DescribeRuleOutput) SetDescription(v string) *DescribeRuleOutput

SetDescription sets the Description field's value.

func (*DescribeRuleOutput) SetEventPattern

func (s *DescribeRuleOutput) SetEventPattern(v string) *DescribeRuleOutput

SetEventPattern sets the EventPattern field's value.

func (*DescribeRuleOutput) SetName

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

SetName sets the Name field's value.

func (*DescribeRuleOutput) SetRoleArn

func (s *DescribeRuleOutput) SetRoleArn(v string) *DescribeRuleOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeRuleOutput) SetScheduleExpression

func (s *DescribeRuleOutput) SetScheduleExpression(v string) *DescribeRuleOutput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*DescribeRuleOutput) SetState

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 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) SetName

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

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

type EcsParameters struct {

    // The number of tasks to create based on the TaskDefinition. The default is
    // one.
    TaskCount *int64 `min:"1" type:"integer"`

    // The ARN of the task definition to use if the event target is an Amazon ECS
    // cluster.
    //
    // 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 cluster.

func (EcsParameters) GoString

func (s EcsParameters) GoString() string

GoString returns the string representation

func (*EcsParameters) SetTaskCount

func (s *EcsParameters) SetTaskCount(v int64) *EcsParameters

SetTaskCount sets the TaskCount field's value.

func (*EcsParameters) SetTaskDefinitionArn

func (s *EcsParameters) SetTaskDefinitionArn(v string) *EcsParameters

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (EcsParameters) String

func (s EcsParameters) String() string

String returns the string representation

func (*EcsParameters) Validate

func (s *EcsParameters) Validate() error

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

type EnableRuleInput

type EnableRuleInput struct {

    // 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) SetName

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

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 InputTransformer

type InputTransformer struct {

    // Map of JSON paths to be extracted from the event. These are key-value pairs,
    // where each value is a JSON path. You must use JSON dot notation, not bracket
    // notation.
    InputPathsMap map[string]*string `type:"map"`

    // Input template where you can use the values of the keys from InputPathsMap
    // to customize the data sent to the target.
    //
    // 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

func (s InputTransformer) GoString() string

GoString returns the string representation

func (*InputTransformer) SetInputPathsMap

func (s *InputTransformer) SetInputPathsMap(v map[string]*string) *InputTransformer

SetInputPathsMap sets the InputPathsMap field's value.

func (*InputTransformer) SetInputTemplate

func (s *InputTransformer) SetInputTemplate(v string) *InputTransformer

SetInputTemplate sets the InputTemplate field's value.

func (InputTransformer) String

func (s InputTransformer) String() string

String returns the string representation

func (*InputTransformer) Validate

func (s *InputTransformer) Validate() error

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

type KinesisParameters

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 (http://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 stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

func (KinesisParameters) GoString

func (s KinesisParameters) GoString() string

GoString returns the string representation

func (*KinesisParameters) SetPartitionKeyPath

func (s *KinesisParameters) SetPartitionKeyPath(v string) *KinesisParameters

SetPartitionKeyPath sets the PartitionKeyPath field's value.

func (KinesisParameters) String

func (s KinesisParameters) String() string

String returns the string representation

func (*KinesisParameters) Validate

func (s *KinesisParameters) Validate() error

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

type ListRuleNamesByTargetInput

type ListRuleNamesByTargetInput struct {

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

    // The token returned by a previous call to 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) SetLimit

func (s *ListRuleNamesByTargetInput) SetLimit(v int64) *ListRuleNamesByTargetInput

SetLimit sets the Limit field's value.

func (*ListRuleNamesByTargetInput) SetNextToken

func (s *ListRuleNamesByTargetInput) SetNextToken(v string) *ListRuleNamesByTargetInput

SetNextToken sets the NextToken field's value.

func (*ListRuleNamesByTargetInput) SetTargetArn

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

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

func (s *ListRuleNamesByTargetOutput) SetNextToken(v string) *ListRuleNamesByTargetOutput

SetNextToken sets the NextToken field's value.

func (*ListRuleNamesByTargetOutput) SetRuleNames

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 {

    // 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) SetLimit

func (s *ListRulesInput) SetLimit(v int64) *ListRulesInput

SetLimit sets the Limit field's value.

func (*ListRulesInput) SetNamePrefix

func (s *ListRulesInput) SetNamePrefix(v string) *ListRulesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListRulesInput) SetNextToken

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

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

func (s *ListRulesOutput) SetNextToken(v string) *ListRulesOutput

SetNextToken sets the NextToken field's value.

func (*ListRulesOutput) SetRules

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 ListTargetsByRuleInput

type ListTargetsByRuleInput struct {

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

    // The token returned by a previous call to 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) SetLimit

func (s *ListTargetsByRuleInput) SetLimit(v int64) *ListTargetsByRuleInput

SetLimit sets the Limit field's value.

func (*ListTargetsByRuleInput) SetNextToken

func (s *ListTargetsByRuleInput) SetNextToken(v string) *ListTargetsByRuleInput

SetNextToken sets the NextToken field's value.

func (*ListTargetsByRuleInput) SetRule

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

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

func (s *ListTargetsByRuleOutput) SetNextToken(v string) *ListTargetsByRuleOutput

SetNextToken sets the NextToken field's value.

func (*ListTargetsByRuleOutput) SetTargets

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 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

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

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

func (s *PutEventsOutput) SetEntries(v []*PutEventsResultEntry) *PutEventsOutput

SetEntries sets the Entries field's value.

func (*PutEventsOutput) SetFailedEntryCount

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 may
    // contain fields and nested subobjects.
    Detail *string `type:"string"`

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

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

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

    // 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" timestampFormat:"unix"`
    // 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

func (s *PutEventsRequestEntry) SetDetail(v string) *PutEventsRequestEntry

SetDetail sets the Detail field's value.

func (*PutEventsRequestEntry) SetDetailType

func (s *PutEventsRequestEntry) SetDetailType(v string) *PutEventsRequestEntry

SetDetailType sets the DetailType field's value.

func (*PutEventsRequestEntry) SetResources

func (s *PutEventsRequestEntry) SetResources(v []*string) *PutEventsRequestEntry

SetResources sets the Resources field's value.

func (*PutEventsRequestEntry) SetSource

func (s *PutEventsRequestEntry) SetSource(v string) *PutEventsRequestEntry

SetSource sets the Source field's value.

func (*PutEventsRequestEntry) SetTime

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

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

func (s *PutEventsResultEntry) SetErrorCode(v string) *PutEventsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutEventsResultEntry) SetErrorMessage

func (s *PutEventsResultEntry) SetErrorMessage(v string) *PutEventsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutEventsResultEntry) SetEventId

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 PutPermissionInput

type PutPermissionInput struct {

    // The action that you are 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"`

    // 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 "*", avoid creating rules that may 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 from which to receive
    // events. Rules with an account field do not 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 are 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

func (s PutPermissionInput) GoString() string

GoString returns the string representation

func (*PutPermissionInput) SetAction

func (s *PutPermissionInput) SetAction(v string) *PutPermissionInput

SetAction sets the Action field's value.

func (*PutPermissionInput) SetPrincipal

func (s *PutPermissionInput) SetPrincipal(v string) *PutPermissionInput

SetPrincipal sets the Principal field's value.

func (*PutPermissionInput) SetStatementId

func (s *PutPermissionInput) SetStatementId(v string) *PutPermissionInput

SetStatementId sets the StatementId field's value.

func (PutPermissionInput) String

func (s PutPermissionInput) String() string

String returns the string representation

func (*PutPermissionInput) Validate

func (s *PutPermissionInput) Validate() error

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

type PutPermissionOutput

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

func (PutPermissionOutput) GoString

func (s PutPermissionOutput) GoString() string

GoString returns the string representation

func (PutPermissionOutput) String

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 pattern. For more information, see Events and Event Patterns (http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html)
    // in the Amazon CloudWatch Events User Guide.
    EventPattern *string `type:"string"`

    // The name of the rule that you are 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"`
    // contains filtered or unexported fields
}

func (PutRuleInput) GoString

func (s PutRuleInput) GoString() string

GoString returns the string representation

func (*PutRuleInput) SetDescription

func (s *PutRuleInput) SetDescription(v string) *PutRuleInput

SetDescription sets the Description field's value.

func (*PutRuleInput) SetEventPattern

func (s *PutRuleInput) SetEventPattern(v string) *PutRuleInput

SetEventPattern sets the EventPattern field's value.

func (*PutRuleInput) SetName

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

SetName sets the Name field's value.

func (*PutRuleInput) SetRoleArn

func (s *PutRuleInput) SetRoleArn(v string) *PutRuleInput

SetRoleArn sets the RoleArn field's value.

func (*PutRuleInput) SetScheduleExpression

func (s *PutRuleInput) SetScheduleExpression(v string) *PutRuleInput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*PutRuleInput) SetState

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

SetState sets the State field's value.

func (PutRuleInput) String

func (s PutRuleInput) String() string

String returns the string representation

func (*PutRuleInput) Validate

func (s *PutRuleInput) Validate() error

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

type PutRuleOutput

type PutRuleOutput struct {

    // The Amazon Resource Name (ARN) 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

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 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) SetRule

func (s *PutTargetsInput) SetRule(v string) *PutTargetsInput

SetRule sets the Rule field's value.

func (*PutTargetsInput) SetTargets

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

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

func (s *PutTargetsOutput) SetFailedEntries(v []*PutTargetsResultEntry) *PutTargetsOutput

SetFailedEntries sets the FailedEntries field's value.

func (*PutTargetsOutput) SetFailedEntryCount

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

func (s *PutTargetsResultEntry) SetErrorCode(v string) *PutTargetsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutTargetsResultEntry) SetErrorMessage

func (s *PutTargetsResultEntry) SetErrorMessage(v string) *PutTargetsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutTargetsResultEntry) SetTargetId

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

type RemovePermissionInput struct {

    // 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

func (s RemovePermissionInput) GoString() string

GoString returns the string representation

func (*RemovePermissionInput) SetStatementId

func (s *RemovePermissionInput) SetStatementId(v string) *RemovePermissionInput

SetStatementId sets the StatementId field's value.

func (RemovePermissionInput) String

func (s RemovePermissionInput) String() string

String returns the string representation

func (*RemovePermissionInput) Validate

func (s *RemovePermissionInput) Validate() error

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

type RemovePermissionOutput

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

func (RemovePermissionOutput) GoString

func (s RemovePermissionOutput) GoString() string

GoString returns the string representation

func (RemovePermissionOutput) String

func (s RemovePermissionOutput) String() string

String returns the string representation

type RemoveTargetsInput

type RemoveTargetsInput struct {

    // 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) SetIds

func (s *RemoveTargetsInput) SetIds(v []*string) *RemoveTargetsInput

SetIds sets the Ids field's value.

func (*RemoveTargetsInput) SetRule

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

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

func (s *RemoveTargetsOutput) SetFailedEntries(v []*RemoveTargetsResultEntry) *RemoveTargetsOutput

SetFailedEntries sets the FailedEntries field's value.

func (*RemoveTargetsOutput) SetFailedEntryCount

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

func (s *RemoveTargetsResultEntry) SetErrorCode(v string) *RemoveTargetsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*RemoveTargetsResultEntry) SetErrorMessage

func (s *RemoveTargetsResultEntry) SetErrorMessage(v string) *RemoveTargetsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*RemoveTargetsResultEntry) SetTargetId

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 pattern of the rule. For more information, see Events and Event
    // Patterns (http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html)
    // in the Amazon CloudWatch Events User Guide.
    EventPattern *string `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 * * ? *)", "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 CloudWatch Events.

func (Rule) GoString

func (s Rule) GoString() string

GoString returns the string representation

func (*Rule) SetArn

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

SetArn sets the Arn field's value.

func (*Rule) SetDescription

func (s *Rule) SetDescription(v string) *Rule

SetDescription sets the Description field's value.

func (*Rule) SetEventPattern

func (s *Rule) SetEventPattern(v string) *Rule

SetEventPattern sets the EventPattern field's value.

func (*Rule) SetName

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

SetName sets the Name field's value.

func (*Rule) SetRoleArn

func (s *Rule) SetRoleArn(v string) *Rule

SetRoleArn sets the RoleArn field's value.

func (*Rule) SetScheduleExpression

func (s *Rule) SetScheduleExpression(v string) *Rule

SetScheduleExpression sets the ScheduleExpression field's value.

func (*Rule) SetState

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

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

func (s RunCommandParameters) GoString() string

GoString returns the string representation

func (*RunCommandParameters) SetRunCommandTargets

func (s *RunCommandParameters) SetRunCommandTargets(v []*RunCommandTarget) *RunCommandParameters

SetRunCommandTargets sets the RunCommandTargets field's value.

func (RunCommandParameters) String

func (s RunCommandParameters) String() string

String returns the string representation

func (*RunCommandParameters) Validate

func (s *RunCommandParameters) Validate() error

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

type RunCommandTarget

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 may specify multiple values.

func (RunCommandTarget) GoString

func (s RunCommandTarget) GoString() string

GoString returns the string representation

func (*RunCommandTarget) SetKey

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

SetKey sets the Key field's value.

func (*RunCommandTarget) SetValues

func (s *RunCommandTarget) SetValues(v []*string) *RunCommandTarget

SetValues sets the Values field's value.

func (RunCommandTarget) String

func (s RunCommandTarget) String() string

String returns the string representation

func (*RunCommandTarget) Validate

func (s *RunCommandTarget) Validate() error

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

type SqsParameters

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

func (s SqsParameters) GoString() string

GoString returns the string representation

func (*SqsParameters) SetMessageGroupId

func (s *SqsParameters) SetMessageGroupId(v string) *SqsParameters

SetMessageGroupId sets the MessageGroupId field's value.

func (SqsParameters) String

func (s SqsParameters) 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"`

    // Contains the job definition, job name, and other parameters if the event
    // target is an AWS Batch job. For more information about AWS Batch, see Jobs
    // (http://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  (http://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 you can use to control shard assignment, when the target
    // is an Amazon Kinesis stream. If you do not 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.
    SqsParameters *SqsParameters `type:"structure"`
    // contains filtered or unexported fields
}

Targets are the resources to be invoked when a rule is triggered. Target types include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, Run Command, and built-in targets.

func (Target) GoString

func (s Target) GoString() string

GoString returns the string representation

func (*Target) SetArn

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

SetArn sets the Arn field's value.

func (*Target) SetBatchParameters

func (s *Target) SetBatchParameters(v *BatchParameters) *Target

SetBatchParameters sets the BatchParameters field's value.

func (*Target) SetEcsParameters

func (s *Target) SetEcsParameters(v *EcsParameters) *Target

SetEcsParameters sets the EcsParameters field's value.

func (*Target) SetId

func (s *Target) SetId(v string) *Target

SetId sets the Id field's value.

func (*Target) SetInput

func (s *Target) SetInput(v string) *Target

SetInput sets the Input field's value.

func (*Target) SetInputPath

func (s *Target) SetInputPath(v string) *Target

SetInputPath sets the InputPath field's value.

func (*Target) SetInputTransformer

func (s *Target) SetInputTransformer(v *InputTransformer) *Target

SetInputTransformer sets the InputTransformer field's value.

func (*Target) SetKinesisParameters

func (s *Target) SetKinesisParameters(v *KinesisParameters) *Target

SetKinesisParameters sets the KinesisParameters field's value.

func (*Target) SetRoleArn

func (s *Target) SetRoleArn(v string) *Target

SetRoleArn sets the RoleArn field's value.

func (*Target) SetRunCommandParameters

func (s *Target) SetRunCommandParameters(v *RunCommandParameters) *Target

SetRunCommandParameters sets the RunCommandParameters field's value.

func (*Target) SetSqsParameters

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

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 Events and Event Patterns (http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/CloudWatchEventsandEventPatterns.html)
    // in the Amazon CloudWatch Events 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

func (s *TestEventPatternInput) SetEvent(v string) *TestEventPatternInput

SetEvent sets the Event field's value.

func (*TestEventPatternInput) SetEventPattern

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

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

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