cloudwatchevents

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 43

Documentation

Overview

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

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

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

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

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

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide (https://docs.aws.amazon.com/eventbridge/latest/userguide).

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

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

Using the Client

To use 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 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatchevents/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon CloudWatch Events" // Service's name
	ServiceID   = "CloudWatchEvents"         // Service's identifier
	EndpointsID = "events"                   // Service's Endpoint identifier
)
View Source 
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"

	// ErrCodeInvalidStateException for service response error code
	// "InvalidStateException".
	//
	// The specified state is not a valid state for an event source.
	ErrCodeInvalidStateException = "InvalidStateException"

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

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

	// ErrCodeOperationDisabledException for service response error code
	// "OperationDisabledException".
	//
	// The operation you are attempting is not available in this region.
	ErrCodeOperationDisabledException = "OperationDisabledException"

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

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

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// An entity that you specified does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateEventSourceInput added in v0.10.0 

type ActivateEventSourceInput struct {

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

func (ActivateEventSourceInput) String added in v0.10.0 

func (s ActivateEventSourceInput) String() string

String returns the string representation

func (*ActivateEventSourceInput) Validate added in v0.10.0 

func (s *ActivateEventSourceInput) Validate() error

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

type ActivateEventSourceOutput added in v0.10.0 

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

func (ActivateEventSourceOutput) String added in v0.10.0 

func (s ActivateEventSourceOutput) String() string

String returns the string representation

type ActivateEventSourceRequest added in v0.10.0 

type ActivateEventSourceRequest struct {
	*aws.Request
	Input *ActivateEventSourceInput
	Copy  func(*ActivateEventSourceInput) ActivateEventSourceRequest
}

ActivateEventSourceRequest is the request type for the ActivateEventSource API operation.

func (ActivateEventSourceRequest) Send added in v0.10.0 

func (r ActivateEventSourceRequest) Send(ctx context.Context) (*ActivateEventSourceResponse, error)

Send marshals and sends the ActivateEventSource API request.

type ActivateEventSourceResponse added in v0.10.0 

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

ActivateEventSourceResponse is the response type for the ActivateEventSource API operation.

func (*ActivateEventSourceResponse) SDKResponseMetdata added in v0.10.0 

func (r *ActivateEventSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ActivateEventSource request.

type AssignPublicIp added in v0.5.0 

type AssignPublicIp string
const (
	AssignPublicIpEnabled  AssignPublicIp = "ENABLED"
	AssignPublicIpDisabled AssignPublicIp = "DISABLED"
)

Enum values for AssignPublicIp

func (AssignPublicIp) MarshalValue added in v0.5.0 

func (enum AssignPublicIp) MarshalValue() (string, error)

func (AssignPublicIp) MarshalValueBuf added in v0.5.0 

func (enum AssignPublicIp) MarshalValueBuf(b []byte) ([]byte, error)

type AwsVpcConfiguration added in v0.5.0 

type AwsVpcConfiguration struct {

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

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

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

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

func (AwsVpcConfiguration) String added in v0.5.0 

func (s AwsVpcConfiguration) String() string

String returns the string representation

func (*AwsVpcConfiguration) Validate added in v0.5.0 

func (s *AwsVpcConfiguration) Validate() error

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

type BatchArrayProperties added in v0.3.0 

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) String added in v0.3.0 

func (s BatchArrayProperties) String() string

String returns the string representation

type BatchParameters added in v0.3.0 

type BatchParameters struct {

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

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

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

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

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

func (BatchParameters) String added in v0.3.0 

func (s BatchParameters) String() string

String returns the string representation

func (*BatchParameters) Validate added in v0.3.0 

func (s *BatchParameters) Validate() error

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

type BatchRetryStrategy added in v0.3.0 

type BatchRetryStrategy struct {

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

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

func (BatchRetryStrategy) String added in v0.3.0 

func (s BatchRetryStrategy) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

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

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := cloudwatchevents.New(myConfig)

func (*Client) ActivateEventSourceRequest added in v0.10.0 

func (c *Client) ActivateEventSourceRequest(input *ActivateEventSourceInput) ActivateEventSourceRequest

ActivateEventSourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using ActivateEventSourceRequest.
req := client.ActivateEventSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateEventBusRequest added in v0.10.0 

func (c *Client) CreateEventBusRequest(input *CreateEventBusInput) CreateEventBusRequest

CreateEventBusRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using CreateEventBusRequest.
req := client.CreateEventBusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreatePartnerEventSourceRequest added in v0.10.0 

func (c *Client) CreatePartnerEventSourceRequest(input *CreatePartnerEventSourceInput) CreatePartnerEventSourceRequest

CreatePartnerEventSourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.

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

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

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

Partner event source names follow this format:

partner_name/event_namespace/event_name

partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events. 

// Example sending a request using CreatePartnerEventSourceRequest.
req := client.CreatePartnerEventSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeactivateEventSourceRequest added in v0.10.0 

func (c *Client) DeactivateEventSourceRequest(input *DeactivateEventSourceInput) DeactivateEventSourceRequest

DeactivateEventSourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted.

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

To activate a deactivated partner event source, use ActivateEventSource. 

// Example sending a request using DeactivateEventSourceRequest.
req := client.DeactivateEventSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteEventBusRequest added in v0.10.0 

func (c *Client) DeleteEventBusRequest(input *DeleteEventBusInput) DeleteEventBusRequest

DeleteEventBusRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using DeleteEventBusRequest.
req := client.DeleteEventBusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeletePartnerEventSourceRequest added in v0.10.0 

func (c *Client) DeletePartnerEventSourceRequest(input *DeletePartnerEventSourceInput) DeletePartnerEventSourceRequest

DeletePartnerEventSourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.

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

// Example sending a request using DeletePartnerEventSourceRequest.
req := client.DeletePartnerEventSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteRuleRequest added in v0.9.0 

func (c *Client) DeleteRuleRequest(input *DeleteRuleInput) DeleteRuleRequest

DeleteRuleRequest returns a request value for making API operation for Amazon CloudWatch Events.

Deletes the specified rule.

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

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

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

// Example sending a request using DeleteRuleRequest.
req := client.DeleteRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEventBusRequest added in v0.9.0 

func (c *Client) DescribeEventBusRequest(input *DescribeEventBusInput) DescribeEventBusRequest

DescribeEventBusRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

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

For more information about partner event buses, see CreateEventBus. 

// Example sending a request using DescribeEventBusRequest.
req := client.DescribeEventBusRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEventSourceRequest added in v0.10.0 

func (c *Client) DescribeEventSourceRequest(input *DescribeEventSourceInput) DescribeEventSourceRequest

DescribeEventSourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using DescribeEventSourceRequest.
req := client.DescribeEventSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribePartnerEventSourceRequest added in v0.10.0 

func (c *Client) DescribePartnerEventSourceRequest(input *DescribePartnerEventSourceInput) DescribePartnerEventSourceRequest

DescribePartnerEventSourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using DescribePartnerEventSourceRequest.
req := client.DescribePartnerEventSourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeRuleRequest added in v0.9.0 

func (c *Client) DescribeRuleRequest(input *DescribeRuleInput) DescribeRuleRequest

DescribeRuleRequest returns a request value for making API operation for Amazon CloudWatch Events.

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. 

// Example sending a request using DescribeRuleRequest.
req := client.DescribeRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DisableRuleRequest added in v0.9.0 

func (c *Client) DisableRuleRequest(input *DisableRuleInput) DisableRuleRequest

DisableRuleRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

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

// Example sending a request using DisableRuleRequest.
req := client.DisableRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) EnableRuleRequest added in v0.9.0 

func (c *Client) EnableRuleRequest(input *EnableRuleInput) EnableRuleRequest

EnableRuleRequest returns a request value for making 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. Allow a short period of time for changes to take effect. 

// Example sending a request using EnableRuleRequest.
req := client.EnableRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListEventBusesRequest added in v0.10.0 

func (c *Client) ListEventBusesRequest(input *ListEventBusesInput) ListEventBusesRequest

ListEventBusesRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using ListEventBusesRequest.
req := client.ListEventBusesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListEventSourcesRequest added in v0.10.0 

func (c *Client) ListEventSourcesRequest(input *ListEventSourcesInput) ListEventSourcesRequest

ListEventSourcesRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using ListEventSourcesRequest.
req := client.ListEventSourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListPartnerEventSourceAccountsRequest added in v0.10.0 

func (c *Client) ListPartnerEventSourceAccountsRequest(input *ListPartnerEventSourceAccountsInput) ListPartnerEventSourceAccountsRequest

ListPartnerEventSourceAccountsRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using ListPartnerEventSourceAccountsRequest.
req := client.ListPartnerEventSourceAccountsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListPartnerEventSourcesRequest added in v0.10.0 

func (c *Client) ListPartnerEventSourcesRequest(input *ListPartnerEventSourcesInput) ListPartnerEventSourcesRequest

ListPartnerEventSourcesRequest returns a request value for making API operation for Amazon CloudWatch Events.

An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers. 

// Example sending a request using ListPartnerEventSourcesRequest.
req := client.ListPartnerEventSourcesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListRuleNamesByTargetRequest added in v0.9.0 

func (c *Client) ListRuleNamesByTargetRequest(input *ListRuleNamesByTargetInput) ListRuleNamesByTargetRequest

ListRuleNamesByTargetRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using ListRuleNamesByTargetRequest.
req := client.ListRuleNamesByTargetRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListRulesRequest added in v0.9.0 

func (c *Client) ListRulesRequest(input *ListRulesInput) ListRulesRequest

ListRulesRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule. 

// Example sending a request using ListRulesRequest.
req := client.ListRulesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTargetsByRuleRequest added in v0.9.0 

func (c *Client) ListTargetsByRuleRequest(input *ListTargetsByRuleInput) ListTargetsByRuleRequest

ListTargetsByRuleRequest returns a request value for making API operation for Amazon CloudWatch Events.

Lists the targets assigned to the specified rule. 

// Example sending a request using ListTargetsByRuleRequest.
req := client.ListTargetsByRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutEventsRequest added in v0.9.0 

func (c *Client) PutEventsRequest(input *PutEventsInput) PutEventsRequest

PutEventsRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using PutEventsRequest.
req := client.PutEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutPartnerEventsRequest added in v0.10.0 

func (c *Client) PutPartnerEventsRequest(input *PutPartnerEventsInput) PutPartnerEventsRequest

PutPartnerEventsRequest returns a request value for making API operation for Amazon CloudWatch Events.

This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation. 

// Example sending a request using PutPartnerEventsRequest.
req := client.PutPartnerEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutPermissionRequest added in v0.9.0 

func (c *Client) PutPermissionRequest(input *PutPermissionInput) PutPermissionRequest

PutPermissionRequest returns a request value for making API operation for Amazon CloudWatch Events.

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.

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

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

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

The permission policy on the default event bus cannot exceed 10 KB in size. 

// Example sending a request using PutPermissionRequest.
req := client.PutPermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutRuleRequest added in v0.9.0 

func (c *Client) PutRuleRequest(input *PutRuleInput) PutRuleRequest

PutRuleRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

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

If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments 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. Allow a short period of time for changes to take effect.

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

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

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

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

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

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

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

// Example sending a request using PutRuleRequest.
req := client.PutRuleRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) PutTargetsRequest added in v0.9.0 

func (c *Client) PutTargetsRequest(input *PutTargetsInput) PutTargetsRequest

PutTargetsRequest returns a request value for making 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 Events:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

  • Amazon API Gateway REST APIs

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

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

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

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

Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

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

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

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

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

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

  • If InputPath is specified in the form of JSONPath (for example, $.detail), 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. 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. 

// Example sending a request using PutTargetsRequest.
req := client.PutTargetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RemovePermissionRequest added in v0.9.0 

func (c *Client) RemovePermissionRequest(input *RemovePermissionInput) RemovePermissionRequest

RemovePermissionRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

// Example sending a request using RemovePermissionRequest.
req := client.RemovePermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RemoveTargetsRequest added in v0.9.0 

func (c *Client) RemoveTargetsRequest(input *RemoveTargetsInput) RemoveTargetsRequest

RemoveTargetsRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

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

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

// Example sending a request using RemoveTargetsRequest.
req := client.RemoveTargetsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

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

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

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

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

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) TestEventPatternRequest added in v0.9.0 

func (c *Client) TestEventPatternRequest(input *TestEventPatternInput) TestEventPatternRequest

TestEventPatternRequest returns a request value for making API operation for Amazon CloudWatch Events.

Tests whether the specified event pattern matches the provided event.

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

// Example sending a request using TestEventPatternRequest.
req := client.TestEventPatternRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for Amazon CloudWatch Events.

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type Condition added in v0.6.0 

type Condition struct {

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

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

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

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

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

func (Condition) String added in v0.6.0 

func (s Condition) String() string

String returns the string representation

func (*Condition) Validate added in v0.6.0 

func (s *Condition) Validate() error

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

type CreateEventBusInput added in v0.10.0 

type CreateEventBusInput struct {

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

	// The name of the new event bus.
	//
	// Event bus names cannot contain the / character. You can't use the name default
	// for a custom event bus, as this name is already used for your account's default
	// event bus.
	//
	// If this is a partner event bus, the name must exactly match the name of the
	// partner event source that this event bus is matched to.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Tags to associate with the event bus.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateEventBusInput) String added in v0.10.0 

func (s CreateEventBusInput) String() string

String returns the string representation

func (*CreateEventBusInput) Validate added in v0.10.0 

func (s *CreateEventBusInput) Validate() error

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

type CreateEventBusOutput added in v0.10.0 

type CreateEventBusOutput struct {

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

func (CreateEventBusOutput) String added in v0.10.0 

func (s CreateEventBusOutput) String() string

String returns the string representation

type CreateEventBusRequest added in v0.10.0 

type CreateEventBusRequest struct {
	*aws.Request
	Input *CreateEventBusInput
	Copy  func(*CreateEventBusInput) CreateEventBusRequest
}

CreateEventBusRequest is the request type for the CreateEventBus API operation.

func (CreateEventBusRequest) Send added in v0.10.0 

func (r CreateEventBusRequest) Send(ctx context.Context) (*CreateEventBusResponse, error)

Send marshals and sends the CreateEventBus API request.

type CreateEventBusResponse added in v0.10.0 

type CreateEventBusResponse struct {
	*CreateEventBusOutput
	// contains filtered or unexported fields
}

CreateEventBusResponse is the response type for the CreateEventBus API operation.

func (*CreateEventBusResponse) SDKResponseMetdata added in v0.10.0 

func (r *CreateEventBusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateEventBus request.

type CreatePartnerEventSourceInput added in v0.10.0 

type CreatePartnerEventSourceInput struct {

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

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

func (CreatePartnerEventSourceInput) String added in v0.10.0 

func (s CreatePartnerEventSourceInput) String() string

String returns the string representation

func (*CreatePartnerEventSourceInput) Validate added in v0.10.0 

func (s *CreatePartnerEventSourceInput) Validate() error

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

type CreatePartnerEventSourceOutput added in v0.10.0 

type CreatePartnerEventSourceOutput struct {

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

func (CreatePartnerEventSourceOutput) String added in v0.10.0 

func (s CreatePartnerEventSourceOutput) String() string

String returns the string representation

type CreatePartnerEventSourceRequest added in v0.10.0 

type CreatePartnerEventSourceRequest struct {
	*aws.Request
	Input *CreatePartnerEventSourceInput
	Copy  func(*CreatePartnerEventSourceInput) CreatePartnerEventSourceRequest
}

CreatePartnerEventSourceRequest is the request type for the CreatePartnerEventSource API operation.

func (CreatePartnerEventSourceRequest) Send added in v0.10.0 

func (r CreatePartnerEventSourceRequest) Send(ctx context.Context) (*CreatePartnerEventSourceResponse, error)

Send marshals and sends the CreatePartnerEventSource API request.

type CreatePartnerEventSourceResponse added in v0.10.0 

type CreatePartnerEventSourceResponse struct {
	*CreatePartnerEventSourceOutput
	// contains filtered or unexported fields
}

CreatePartnerEventSourceResponse is the response type for the CreatePartnerEventSource API operation.

func (*CreatePartnerEventSourceResponse) SDKResponseMetdata added in v0.10.0 

func (r *CreatePartnerEventSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreatePartnerEventSource request.

type DeactivateEventSourceInput added in v0.10.0 

type DeactivateEventSourceInput struct {

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

func (DeactivateEventSourceInput) String added in v0.10.0 

func (s DeactivateEventSourceInput) String() string

String returns the string representation

func (*DeactivateEventSourceInput) Validate added in v0.10.0 

func (s *DeactivateEventSourceInput) Validate() error

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

type DeactivateEventSourceOutput added in v0.10.0 

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

func (DeactivateEventSourceOutput) String added in v0.10.0 

func (s DeactivateEventSourceOutput) String() string

String returns the string representation

type DeactivateEventSourceRequest added in v0.10.0 

type DeactivateEventSourceRequest struct {
	*aws.Request
	Input *DeactivateEventSourceInput
	Copy  func(*DeactivateEventSourceInput) DeactivateEventSourceRequest
}

DeactivateEventSourceRequest is the request type for the DeactivateEventSource API operation.

func (DeactivateEventSourceRequest) Send added in v0.10.0 

func (r DeactivateEventSourceRequest) Send(ctx context.Context) (*DeactivateEventSourceResponse, error)

Send marshals and sends the DeactivateEventSource API request.

type DeactivateEventSourceResponse added in v0.10.0 

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

DeactivateEventSourceResponse is the response type for the DeactivateEventSource API operation.

func (*DeactivateEventSourceResponse) SDKResponseMetdata added in v0.10.0 

func (r *DeactivateEventSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeactivateEventSource request.

type DeleteEventBusInput added in v0.10.0 

type DeleteEventBusInput struct {

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

func (DeleteEventBusInput) String added in v0.10.0 

func (s DeleteEventBusInput) String() string

String returns the string representation

func (*DeleteEventBusInput) Validate added in v0.10.0 

func (s *DeleteEventBusInput) Validate() error

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

type DeleteEventBusOutput added in v0.10.0 

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

func (DeleteEventBusOutput) String added in v0.10.0 

func (s DeleteEventBusOutput) String() string

String returns the string representation

type DeleteEventBusRequest added in v0.10.0 

type DeleteEventBusRequest struct {
	*aws.Request
	Input *DeleteEventBusInput
	Copy  func(*DeleteEventBusInput) DeleteEventBusRequest
}

DeleteEventBusRequest is the request type for the DeleteEventBus API operation.

func (DeleteEventBusRequest) Send added in v0.10.0 

func (r DeleteEventBusRequest) Send(ctx context.Context) (*DeleteEventBusResponse, error)

Send marshals and sends the DeleteEventBus API request.

type DeleteEventBusResponse added in v0.10.0 

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

DeleteEventBusResponse is the response type for the DeleteEventBus API operation.

func (*DeleteEventBusResponse) SDKResponseMetdata added in v0.10.0 

func (r *DeleteEventBusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteEventBus request.

type DeletePartnerEventSourceInput added in v0.10.0 

type DeletePartnerEventSourceInput struct {

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

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

func (DeletePartnerEventSourceInput) String added in v0.10.0 

func (s DeletePartnerEventSourceInput) String() string

String returns the string representation

func (*DeletePartnerEventSourceInput) Validate added in v0.10.0 

func (s *DeletePartnerEventSourceInput) Validate() error

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

type DeletePartnerEventSourceOutput added in v0.10.0 

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

func (DeletePartnerEventSourceOutput) String added in v0.10.0 

func (s DeletePartnerEventSourceOutput) String() string

String returns the string representation

type DeletePartnerEventSourceRequest added in v0.10.0 

type DeletePartnerEventSourceRequest struct {
	*aws.Request
	Input *DeletePartnerEventSourceInput
	Copy  func(*DeletePartnerEventSourceInput) DeletePartnerEventSourceRequest
}

DeletePartnerEventSourceRequest is the request type for the DeletePartnerEventSource API operation.

func (DeletePartnerEventSourceRequest) Send added in v0.10.0 

func (r DeletePartnerEventSourceRequest) Send(ctx context.Context) (*DeletePartnerEventSourceResponse, error)

Send marshals and sends the DeletePartnerEventSource API request.

type DeletePartnerEventSourceResponse added in v0.10.0 

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

DeletePartnerEventSourceResponse is the response type for the DeletePartnerEventSource API operation.

func (*DeletePartnerEventSourceResponse) SDKResponseMetdata added in v0.10.0 

func (r *DeletePartnerEventSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePartnerEventSource request.

type DeleteRuleInput 

type DeleteRuleInput struct {

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

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

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

func (DeleteRuleInput) 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) String 

func (s DeleteRuleOutput) String() string

String returns the string representation

type DeleteRuleRequest 

type DeleteRuleRequest struct {
	*aws.Request
	Input *DeleteRuleInput
	Copy  func(*DeleteRuleInput) DeleteRuleRequest
}

DeleteRuleRequest is the request type for the DeleteRule API operation.

func (DeleteRuleRequest) Send 

func (r DeleteRuleRequest) Send(ctx context.Context) (*DeleteRuleResponse, error)

Send marshals and sends the DeleteRule API request.

type DeleteRuleResponse added in v0.9.0 

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

DeleteRuleResponse is the response type for the DeleteRule API operation.

func (*DeleteRuleResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteRule request.

type DescribeEventBusInput 

type DescribeEventBusInput struct {

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

func (DescribeEventBusInput) String 

func (s DescribeEventBusInput) String() string

String returns the string representation

func (*DescribeEventBusInput) Validate added in v0.10.0 

func (s *DescribeEventBusInput) Validate() error

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

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

func (s DescribeEventBusOutput) String() string

String returns the string representation

type DescribeEventBusRequest 

type DescribeEventBusRequest struct {
	*aws.Request
	Input *DescribeEventBusInput
	Copy  func(*DescribeEventBusInput) DescribeEventBusRequest
}

DescribeEventBusRequest is the request type for the DescribeEventBus API operation.

func (DescribeEventBusRequest) Send 

func (r DescribeEventBusRequest) Send(ctx context.Context) (*DescribeEventBusResponse, error)

Send marshals and sends the DescribeEventBus API request.

type DescribeEventBusResponse added in v0.9.0 

type DescribeEventBusResponse struct {
	*DescribeEventBusOutput
	// contains filtered or unexported fields
}

DescribeEventBusResponse is the response type for the DescribeEventBus API operation.

func (*DescribeEventBusResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventBusResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEventBus request.

type DescribeEventSourceInput added in v0.10.0 

type DescribeEventSourceInput struct {

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

func (DescribeEventSourceInput) String added in v0.10.0 

func (s DescribeEventSourceInput) String() string

String returns the string representation

func (*DescribeEventSourceInput) Validate added in v0.10.0 

func (s *DescribeEventSourceInput) Validate() error

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

type DescribeEventSourceOutput added in v0.10.0 

type DescribeEventSourceOutput struct {

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

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

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

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

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

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

func (DescribeEventSourceOutput) String added in v0.10.0 

func (s DescribeEventSourceOutput) String() string

String returns the string representation

type DescribeEventSourceRequest added in v0.10.0 

type DescribeEventSourceRequest struct {
	*aws.Request
	Input *DescribeEventSourceInput
	Copy  func(*DescribeEventSourceInput) DescribeEventSourceRequest
}

DescribeEventSourceRequest is the request type for the DescribeEventSource API operation.

func (DescribeEventSourceRequest) Send added in v0.10.0 

func (r DescribeEventSourceRequest) Send(ctx context.Context) (*DescribeEventSourceResponse, error)

Send marshals and sends the DescribeEventSource API request.

type DescribeEventSourceResponse added in v0.10.0 

type DescribeEventSourceResponse struct {
	*DescribeEventSourceOutput
	// contains filtered or unexported fields
}

DescribeEventSourceResponse is the response type for the DescribeEventSource API operation.

func (*DescribeEventSourceResponse) SDKResponseMetdata added in v0.10.0 

func (r *DescribeEventSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEventSource request.

type DescribePartnerEventSourceInput added in v0.10.0 

type DescribePartnerEventSourceInput struct {

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

func (DescribePartnerEventSourceInput) String added in v0.10.0 

func (s DescribePartnerEventSourceInput) String() string

String returns the string representation

func (*DescribePartnerEventSourceInput) Validate added in v0.10.0 

func (s *DescribePartnerEventSourceInput) Validate() error

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

type DescribePartnerEventSourceOutput added in v0.10.0 

type DescribePartnerEventSourceOutput struct {

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

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

func (DescribePartnerEventSourceOutput) String added in v0.10.0 

func (s DescribePartnerEventSourceOutput) String() string

String returns the string representation

type DescribePartnerEventSourceRequest added in v0.10.0 

type DescribePartnerEventSourceRequest struct {
	*aws.Request
	Input *DescribePartnerEventSourceInput
	Copy  func(*DescribePartnerEventSourceInput) DescribePartnerEventSourceRequest
}

DescribePartnerEventSourceRequest is the request type for the DescribePartnerEventSource API operation.

func (DescribePartnerEventSourceRequest) Send added in v0.10.0 

func (r DescribePartnerEventSourceRequest) Send(ctx context.Context) (*DescribePartnerEventSourceResponse, error)

Send marshals and sends the DescribePartnerEventSource API request.

type DescribePartnerEventSourceResponse added in v0.10.0 

type DescribePartnerEventSourceResponse struct {
	*DescribePartnerEventSourceOutput
	// contains filtered or unexported fields
}

DescribePartnerEventSourceResponse is the response type for the DescribePartnerEventSource API operation.

func (*DescribePartnerEventSourceResponse) SDKResponseMetdata added in v0.10.0 

func (r *DescribePartnerEventSourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribePartnerEventSource request.

type DescribeRuleInput 

type DescribeRuleInput struct {

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

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

func (DescribeRuleInput) 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 bus associated with the rule.
	EventBusName *string `min:"1" type:"string"`

	// The event pattern. For more information, see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	EventPattern *string `type:"string"`

	// If this is a managed rule, created by an AWS service on your behalf, this
	// field displays the principal name of the AWS service that created the rule.
	ManagedBy *string `min:"1" type:"string"`

	// The name of the rule.
	Name *string `min:"1" type:"string"`

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

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

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

func (DescribeRuleOutput) String 

func (s DescribeRuleOutput) String() string

String returns the string representation

type DescribeRuleRequest 

type DescribeRuleRequest struct {
	*aws.Request
	Input *DescribeRuleInput
	Copy  func(*DescribeRuleInput) DescribeRuleRequest
}

DescribeRuleRequest is the request type for the DescribeRule API operation.

func (DescribeRuleRequest) Send 

func (r DescribeRuleRequest) Send(ctx context.Context) (*DescribeRuleResponse, error)

Send marshals and sends the DescribeRule API request.

type DescribeRuleResponse added in v0.9.0 

type DescribeRuleResponse struct {
	*DescribeRuleOutput
	// contains filtered or unexported fields
}

DescribeRuleResponse is the response type for the DescribeRule API operation.

func (*DescribeRuleResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeRule request.

type DisableRuleInput 

type DisableRuleInput struct {

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

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

func (DisableRuleInput) 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) String 

func (s DisableRuleOutput) String() string

String returns the string representation

type DisableRuleRequest 

type DisableRuleRequest struct {
	*aws.Request
	Input *DisableRuleInput
	Copy  func(*DisableRuleInput) DisableRuleRequest
}

DisableRuleRequest is the request type for the DisableRule API operation.

func (DisableRuleRequest) Send 

func (r DisableRuleRequest) Send(ctx context.Context) (*DisableRuleResponse, error)

Send marshals and sends the DisableRule API request.

type DisableRuleResponse added in v0.9.0 

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

DisableRuleResponse is the response type for the DisableRule API operation.

func (*DisableRuleResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisableRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisableRule request.

type EcsParameters 

type EcsParameters struct {

	// Specifies an ECS task group for the task. The maximum length is 255 characters.
	Group *string `type:"string"`

	// Specifies the launch type on which your task is running. The launch type
	// that you specify here must match one of the launch type (compatibilities)
	// of the target task. The FARGATE value is supported only in the Regions where
	// AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate
	// on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html)
	// in the Amazon Elastic Container Service Developer Guide.
	LaunchType LaunchType `type:"string" enum:"true"`

	// Use this structure if the ECS task uses the awsvpc network mode. This structure
	// specifies the VPC subnets and security groups associated with the task, and
	// whether a public IP address is to be used. This structure is required if
	// LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
	//
	// If you specify NetworkConfiguration when the target ECS task does not use
	// the awsvpc network mode, the task fails.
	NetworkConfiguration *NetworkConfiguration `type:"structure"`

	// Specifies the platform version for the task. Specify only the numeric portion
	// of the platform version, such as 1.1.0.
	//
	// This structure is used only if LaunchType is FARGATE. For more information
	// about valid platform versions, see AWS Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
	// in the Amazon Elastic Container Service Developer Guide.
	PlatformVersion *string `type:"string"`

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

	// The ARN of the task definition to use if the event target is an Amazon ECS
	// task.
	//
	// TaskDefinitionArn is a required field
	TaskDefinitionArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The custom parameters to be used when the target is an Amazon ECS task.

func (EcsParameters) 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 event bus associated with the rule. If you omit this, the default event
	// bus is used.
	EventBusName *string `min:"1" type:"string"`

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

func (EnableRuleInput) 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) String 

func (s EnableRuleOutput) String() string

String returns the string representation

type EnableRuleRequest 

type EnableRuleRequest struct {
	*aws.Request
	Input *EnableRuleInput
	Copy  func(*EnableRuleInput) EnableRuleRequest
}

EnableRuleRequest is the request type for the EnableRule API operation.

func (EnableRuleRequest) Send 

func (r EnableRuleRequest) Send(ctx context.Context) (*EnableRuleResponse, error)

Send marshals and sends the EnableRule API request.

type EnableRuleResponse added in v0.9.0 

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

EnableRuleResponse is the response type for the EnableRule API operation.

func (*EnableRuleResponse) SDKResponseMetdata added in v0.9.0 

func (r *EnableRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the EnableRule request.

type EventBus added in v0.10.0 

type EventBus struct {

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

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

	// The permissions policy of the event bus, describing which other AWS accounts
	// can write events to this event bus.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives rules from AWS services. A custom event bus can receive rules from AWS services as well as your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

func (EventBus) String added in v0.10.0 

func (s EventBus) String() string

String returns the string representation

type EventSource added in v0.10.0 

type EventSource struct {

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

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

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

	// The date and time that the event source will expire, if the AWS account doesn't
	// create a matching event bus for it.
	ExpirationTime *time.Time `type:"timestamp"`

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

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

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.

func (EventSource) String added in v0.10.0 

func (s EventSource) String() string

String returns the string representation

type EventSourceState added in v0.10.0 

type EventSourceState string
const (
	EventSourceStatePending EventSourceState = "PENDING"
	EventSourceStateActive  EventSourceState = "ACTIVE"
	EventSourceStateDeleted EventSourceState = "DELETED"
)

Enum values for EventSourceState

func (EventSourceState) MarshalValue added in v0.10.0 

func (enum EventSourceState) MarshalValue() (string, error)

func (EventSourceState) MarshalValueBuf added in v0.10.0 

func (enum EventSourceState) MarshalValueBuf(b []byte) ([]byte, error)

type HttpParameters added in v0.24.0 

type HttpParameters struct {

	// The headers that need to be sent as part of request invoking the API Gateway
	// REST API.
	HeaderParameters map[string]string `type:"map"`

	// The path parameter values to be used to populate API Gateway REST API path
	// wildcards ("*").
	PathParameterValues []string `type:"list"`

	// The query string keys/values that need to be sent as part of request invoking
	// the API Gateway REST API.
	QueryStringParameters map[string]string `type:"map"`
	// contains filtered or unexported fields
}

These are custom parameter to be used when the target is an API Gateway REST APIs.

func (HttpParameters) String added in v0.24.0 

func (s HttpParameters) String() string

String returns the string representation

type InputTransformer 

type InputTransformer struct {

	// Map of JSON paths to be extracted from the event. You can then insert these
	// in the template in InputTemplate to produce the output you want to be sent
	// to the target.
	//
	// InputPathsMap is an array key-value pairs, where each value is a valid JSON
	// path. You can have as many as 10 key-value pairs. You must use JSON dot notation,
	// not bracket notation.
	//
	// The keys cannot start with "AWS."
	InputPathsMap map[string]string `type:"map"`

	// Input template where you specify placeholders that will be filled with the
	// values of the keys from InputPathsMap to customize the data sent to the target.
	// Enclose each InputPathsMaps value in brackets: <value> The InputTemplate
	// must be valid JSON.
	//
	// If InputTemplate is a JSON object (surrounded by curly braces), the following
	// restrictions apply:
	//
	//    * The placeholder cannot be used as an object key.
	//
	//    * Object values cannot include quote marks.
	//
	// The following example shows the syntax for using InputPathsMap and InputTemplate.
	//
	// "InputTransformer":
	//
	// {
	//
	// "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
	//
	// "InputTemplate": "<instance> is in state <status>"
	//
	// }
	//
	// To have the InputTemplate include quote marks within a JSON string, escape
	// each quote marks with a slash, as in the following example:
	//
	// "InputTransformer":
	//
	// {
	//
	// "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
	//
	// "InputTemplate": "<instance> is in state \"<status>\""
	//
	// }
	//
	// InputTemplate is a required field
	InputTemplate *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

func (InputTransformer) 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 (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key)
	// in the Amazon Kinesis Streams Developer Guide.
	//
	// PartitionKeyPath is a required field
	PartitionKeyPath *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard 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) 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 LaunchType added in v0.5.0 

type LaunchType string
const (
	LaunchTypeEc2     LaunchType = "EC2"
	LaunchTypeFargate LaunchType = "FARGATE"
)

Enum values for LaunchType

func (LaunchType) MarshalValue added in v0.5.0 

func (enum LaunchType) MarshalValue() (string, error)

func (LaunchType) MarshalValueBuf added in v0.5.0 

func (enum LaunchType) MarshalValueBuf(b []byte) ([]byte, error)

type ListEventBusesInput added in v0.10.0 

type ListEventBusesInput struct {

	// Specifying this limits the number of results returned by this operation.
	// The operation also returns a NextToken which you can use in a subsequent
	// operation to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// Specifying this limits the results to only those event buses with names that
	// start with the specified prefix.
	NamePrefix *string `min:"1" type:"string"`

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventBusesInput) String added in v0.10.0 

func (s ListEventBusesInput) String() string

String returns the string representation

func (*ListEventBusesInput) Validate added in v0.10.0 

func (s *ListEventBusesInput) Validate() error

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

type ListEventBusesOutput added in v0.10.0 

type ListEventBusesOutput struct {

	// This list of event buses.
	EventBuses []EventBus `type:"list"`

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventBusesOutput) String added in v0.10.0 

func (s ListEventBusesOutput) String() string

String returns the string representation

type ListEventBusesRequest added in v0.10.0 

type ListEventBusesRequest struct {
	*aws.Request
	Input *ListEventBusesInput
	Copy  func(*ListEventBusesInput) ListEventBusesRequest
}

ListEventBusesRequest is the request type for the ListEventBuses API operation.

func (ListEventBusesRequest) Send added in v0.10.0 

func (r ListEventBusesRequest) Send(ctx context.Context) (*ListEventBusesResponse, error)

Send marshals and sends the ListEventBuses API request.

type ListEventBusesResponse added in v0.10.0 

type ListEventBusesResponse struct {
	*ListEventBusesOutput
	// contains filtered or unexported fields
}

ListEventBusesResponse is the response type for the ListEventBuses API operation.

func (*ListEventBusesResponse) SDKResponseMetdata added in v0.10.0 

func (r *ListEventBusesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListEventBuses request.

type ListEventSourcesInput added in v0.10.0 

type ListEventSourcesInput struct {

	// Specifying this limits the number of results returned by this operation.
	// The operation also returns a NextToken which you can use in a subsequent
	// operation to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// Specifying this limits the results to only those partner event sources with
	// names that start with the specified prefix.
	NamePrefix *string `min:"1" type:"string"`

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventSourcesInput) String added in v0.10.0 

func (s ListEventSourcesInput) String() string

String returns the string representation

func (*ListEventSourcesInput) Validate added in v0.10.0 

func (s *ListEventSourcesInput) Validate() error

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

type ListEventSourcesOutput added in v0.10.0 

type ListEventSourcesOutput struct {

	// The list of event sources.
	EventSources []EventSource `type:"list"`

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventSourcesOutput) String added in v0.10.0 

func (s ListEventSourcesOutput) String() string

String returns the string representation

type ListEventSourcesRequest added in v0.10.0 

type ListEventSourcesRequest struct {
	*aws.Request
	Input *ListEventSourcesInput
	Copy  func(*ListEventSourcesInput) ListEventSourcesRequest
}

ListEventSourcesRequest is the request type for the ListEventSources API operation.

func (ListEventSourcesRequest) Send added in v0.10.0 

func (r ListEventSourcesRequest) Send(ctx context.Context) (*ListEventSourcesResponse, error)

Send marshals and sends the ListEventSources API request.

type ListEventSourcesResponse added in v0.10.0 

type ListEventSourcesResponse struct {
	*ListEventSourcesOutput
	// contains filtered or unexported fields
}

ListEventSourcesResponse is the response type for the ListEventSources API operation.

func (*ListEventSourcesResponse) SDKResponseMetdata added in v0.10.0 

func (r *ListEventSourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListEventSources request.

type ListPartnerEventSourceAccountsInput added in v0.10.0 

type ListPartnerEventSourceAccountsInput struct {

	// The name of the partner event source to display account information about.
	//
	// EventSourceName is a required field
	EventSourceName *string `min:"1" type:"string" required:"true"`

	// Specifying this limits the number of results returned by this operation.
	// The operation also returns a NextToken which you can use in a subsequent
	// operation to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// The token returned by a previous call to this operation. Specifying this
	// retrieves the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourceAccountsInput) String added in v0.10.0 

func (s ListPartnerEventSourceAccountsInput) String() string

String returns the string representation

func (*ListPartnerEventSourceAccountsInput) Validate added in v0.10.0 

func (s *ListPartnerEventSourceAccountsInput) Validate() error

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

type ListPartnerEventSourceAccountsOutput added in v0.10.0 

type ListPartnerEventSourceAccountsOutput struct {

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`

	// The list of partner event sources returned by the operation.
	PartnerEventSourceAccounts []PartnerEventSourceAccount `type:"list"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourceAccountsOutput) String added in v0.10.0 

func (s ListPartnerEventSourceAccountsOutput) String() string

String returns the string representation

type ListPartnerEventSourceAccountsRequest added in v0.10.0 

type ListPartnerEventSourceAccountsRequest struct {
	*aws.Request
	Input *ListPartnerEventSourceAccountsInput
	Copy  func(*ListPartnerEventSourceAccountsInput) ListPartnerEventSourceAccountsRequest
}

ListPartnerEventSourceAccountsRequest is the request type for the ListPartnerEventSourceAccounts API operation.

func (ListPartnerEventSourceAccountsRequest) Send added in v0.10.0 

func (r ListPartnerEventSourceAccountsRequest) Send(ctx context.Context) (*ListPartnerEventSourceAccountsResponse, error)

Send marshals and sends the ListPartnerEventSourceAccounts API request.

type ListPartnerEventSourceAccountsResponse added in v0.10.0 

type ListPartnerEventSourceAccountsResponse struct {
	*ListPartnerEventSourceAccountsOutput
	// contains filtered or unexported fields
}

ListPartnerEventSourceAccountsResponse is the response type for the ListPartnerEventSourceAccounts API operation.

func (*ListPartnerEventSourceAccountsResponse) SDKResponseMetdata added in v0.10.0 

func (r *ListPartnerEventSourceAccountsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPartnerEventSourceAccounts request.

type ListPartnerEventSourcesInput added in v0.10.0 

type ListPartnerEventSourcesInput struct {

	// pecifying this limits the number of results returned by this operation. The
	// operation also returns a NextToken which you can use in a subsequent operation
	// to retrieve the next set of results.
	Limit *int64 `min:"1" type:"integer"`

	// If you specify this, the results are limited to only those partner event
	// sources that start with the string you specify.
	//
	// NamePrefix is a required field
	NamePrefix *string `min:"1" type:"string" required:"true"`

	// The token returned by a previous call to this operation. Specifying this
	// retrieves the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourcesInput) String added in v0.10.0 

func (s ListPartnerEventSourcesInput) String() string

String returns the string representation

func (*ListPartnerEventSourcesInput) Validate added in v0.10.0 

func (s *ListPartnerEventSourcesInput) Validate() error

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

type ListPartnerEventSourcesOutput added in v0.10.0 

type ListPartnerEventSourcesOutput struct {

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`

	// The list of partner event sources returned by the operation.
	PartnerEventSources []PartnerEventSource `type:"list"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourcesOutput) String added in v0.10.0 

func (s ListPartnerEventSourcesOutput) String() string

String returns the string representation

type ListPartnerEventSourcesRequest added in v0.10.0 

type ListPartnerEventSourcesRequest struct {
	*aws.Request
	Input *ListPartnerEventSourcesInput
	Copy  func(*ListPartnerEventSourcesInput) ListPartnerEventSourcesRequest
}

ListPartnerEventSourcesRequest is the request type for the ListPartnerEventSources API operation.

func (ListPartnerEventSourcesRequest) Send added in v0.10.0 

func (r ListPartnerEventSourcesRequest) Send(ctx context.Context) (*ListPartnerEventSourcesResponse, error)

Send marshals and sends the ListPartnerEventSources API request.

type ListPartnerEventSourcesResponse added in v0.10.0 

type ListPartnerEventSourcesResponse struct {
	*ListPartnerEventSourcesOutput
	// contains filtered or unexported fields
}

ListPartnerEventSourcesResponse is the response type for the ListPartnerEventSources API operation.

func (*ListPartnerEventSourcesResponse) SDKResponseMetdata added in v0.10.0 

func (r *ListPartnerEventSourcesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPartnerEventSources request.

type ListRuleNamesByTargetInput 

type ListRuleNamesByTargetInput struct {

	// Limits the results to show only the rules associated with the specified event
	// bus.
	EventBusName *string `min:"1" type:"string"`

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

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the target resource.
	//
	// TargetArn is a required field
	TargetArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListRuleNamesByTargetInput) 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) String 

func (s ListRuleNamesByTargetOutput) String() string

String returns the string representation

type ListRuleNamesByTargetRequest 

type ListRuleNamesByTargetRequest struct {
	*aws.Request
	Input *ListRuleNamesByTargetInput
	Copy  func(*ListRuleNamesByTargetInput) ListRuleNamesByTargetRequest
}

ListRuleNamesByTargetRequest is the request type for the ListRuleNamesByTarget API operation.

func (ListRuleNamesByTargetRequest) Send 

func (r ListRuleNamesByTargetRequest) Send(ctx context.Context) (*ListRuleNamesByTargetResponse, error)

Send marshals and sends the ListRuleNamesByTarget API request.

type ListRuleNamesByTargetResponse added in v0.9.0 

type ListRuleNamesByTargetResponse struct {
	*ListRuleNamesByTargetOutput
	// contains filtered or unexported fields
}

ListRuleNamesByTargetResponse is the response type for the ListRuleNamesByTarget API operation.

func (*ListRuleNamesByTargetResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListRuleNamesByTargetResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListRuleNamesByTarget request.

type ListRulesInput 

type ListRulesInput struct {

	// Limits the results to show only the rules associated with the specified event
	// bus.
	EventBusName *string `min:"1" type:"string"`

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

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

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRulesInput) 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) String 

func (s ListRulesOutput) String() string

String returns the string representation

type ListRulesRequest 

type ListRulesRequest struct {
	*aws.Request
	Input *ListRulesInput
	Copy  func(*ListRulesInput) ListRulesRequest
}

ListRulesRequest is the request type for the ListRules API operation.

func (ListRulesRequest) Send 

func (r ListRulesRequest) Send(ctx context.Context) (*ListRulesResponse, error)

Send marshals and sends the ListRules API request.

type ListRulesResponse added in v0.9.0 

type ListRulesResponse struct {
	*ListRulesOutput
	// contains filtered or unexported fields
}

ListRulesResponse is the response type for the ListRules API operation.

func (*ListRulesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListRulesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListRules request.

type ListTagsForResourceInput added in v0.8.0 

type ListTagsForResourceInput struct {

	// The ARN of the EventBridge resource for which you want to view tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.8.0 

type ListTagsForResourceOutput struct {

	// The list of tag keys and values associated with the resource you specified
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListTargetsByRuleInput 

type ListTargetsByRuleInput struct {

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

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

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

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

func (ListTargetsByRuleInput) 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) String 

func (s ListTargetsByRuleOutput) String() string

String returns the string representation

type ListTargetsByRuleRequest 

type ListTargetsByRuleRequest struct {
	*aws.Request
	Input *ListTargetsByRuleInput
	Copy  func(*ListTargetsByRuleInput) ListTargetsByRuleRequest
}

ListTargetsByRuleRequest is the request type for the ListTargetsByRule API operation.

func (ListTargetsByRuleRequest) Send 

func (r ListTargetsByRuleRequest) Send(ctx context.Context) (*ListTargetsByRuleResponse, error)

Send marshals and sends the ListTargetsByRule API request.

type ListTargetsByRuleResponse added in v0.9.0 

type ListTargetsByRuleResponse struct {
	*ListTargetsByRuleOutput
	// contains filtered or unexported fields
}

ListTargetsByRuleResponse is the response type for the ListTargetsByRule API operation.

func (*ListTargetsByRuleResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTargetsByRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTargetsByRule request.

type NetworkConfiguration added in v0.5.0 

type NetworkConfiguration struct {

	// Use this structure to specify the VPC subnets and security groups for the
	// task, and whether a public IP address is to be used. This structure is relevant
	// only for ECS tasks that use the awsvpc network mode.
	AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

This structure specifies the network configuration for an ECS task.

func (NetworkConfiguration) String added in v0.5.0 

func (s NetworkConfiguration) String() string

String returns the string representation

func (*NetworkConfiguration) Validate added in v0.5.0 

func (s *NetworkConfiguration) Validate() error

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

type PartnerEventSource added in v0.10.0 

type PartnerEventSource struct {

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

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

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.

func (PartnerEventSource) String added in v0.10.0 

func (s PartnerEventSource) String() string

String returns the string representation

type PartnerEventSourceAccount added in v0.10.0 

type PartnerEventSourceAccount struct {

	// The AWS account ID that the partner event source was offered to.
	Account *string `min:"12" type:"string"`

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

	// The date and time that the event source will expire, if the AWS account doesn't
	// create a matching event bus for it.
	ExpirationTime *time.Time `type:"timestamp"`

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

The AWS account that a partner event source has been offered to.

func (PartnerEventSourceAccount) String added in v0.10.0 

func (s PartnerEventSourceAccount) String() string

String returns the string representation

type PutEventsInput 

type PutEventsInput struct {

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

func (PutEventsInput) 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) String 

func (s PutEventsOutput) String() string

String returns the string representation

type PutEventsRequest 

type PutEventsRequest struct {
	*aws.Request
	Input *PutEventsInput
	Copy  func(*PutEventsInput) PutEventsRequest
}

PutEventsRequest is the request type for the PutEvents API operation.

func (PutEventsRequest) Send 

func (r PutEventsRequest) Send(ctx context.Context) (*PutEventsResponse, error)

Send marshals and sends the PutEvents API request.

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

	// The event bus that will receive the event. Only the rules that are associated
	// with this event bus will be able to match the event.
	EventBusName *string `min:"1" 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 time stamp of the event, per RFC3339 (https://www.rfc-editor.org/rfc/rfc3339.txt).
	// If no time stamp is provided, the time stamp of the PutEvents call is used.
	Time *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents an event to be submitted.

func (PutEventsRequestEntry) String 

func (s PutEventsRequestEntry) String() string

String returns the string representation

func (*PutEventsRequestEntry) Validate added in v0.10.0 

func (s *PutEventsRequestEntry) Validate() error

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

type PutEventsResponse added in v0.9.0 

type PutEventsResponse struct {
	*PutEventsOutput
	// contains filtered or unexported fields
}

PutEventsResponse is the response type for the PutEvents API operation.

func (*PutEventsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutEvents request.

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

func (s PutEventsResultEntry) String() string

String returns the string representation

type PutPartnerEventsInput added in v0.10.0 

type PutPartnerEventsInput struct {

	// The list of events to write to the event bus.
	//
	// Entries is a required field
	Entries []PutPartnerEventsRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutPartnerEventsInput) String added in v0.10.0 

func (s PutPartnerEventsInput) String() string

String returns the string representation

func (*PutPartnerEventsInput) Validate added in v0.10.0 

func (s *PutPartnerEventsInput) Validate() error

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

type PutPartnerEventsOutput added in v0.10.0 

type PutPartnerEventsOutput struct {

	// The list of events from this operation that were successfully written to
	// the partner event bus.
	Entries []PutPartnerEventsResultEntry `type:"list"`

	// The number of events from this operation that could not be written to the
	// partner event bus.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (PutPartnerEventsOutput) String added in v0.10.0 

func (s PutPartnerEventsOutput) String() string

String returns the string representation

type PutPartnerEventsRequest added in v0.10.0 

type PutPartnerEventsRequest struct {
	*aws.Request
	Input *PutPartnerEventsInput
	Copy  func(*PutPartnerEventsInput) PutPartnerEventsRequest
}

PutPartnerEventsRequest is the request type for the PutPartnerEvents API operation.

func (PutPartnerEventsRequest) Send added in v0.10.0 

func (r PutPartnerEventsRequest) Send(ctx context.Context) (*PutPartnerEventsResponse, error)

Send marshals and sends the PutPartnerEvents API request.

type PutPartnerEventsRequestEntry added in v0.10.0 

type PutPartnerEventsRequestEntry struct {

	// A valid JSON string. There is no other schema imposed. The JSON string may
	// contain fields and nested subobjects.
	Detail *string `type:"string"`

	// A 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 event source that is generating the evntry.
	Source *string `min:"1" type:"string"`

	// The date and time of the event.
	Time *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The details about an event generated by an SaaS partner.

func (PutPartnerEventsRequestEntry) String added in v0.10.0 

func (s PutPartnerEventsRequestEntry) String() string

String returns the string representation

func (*PutPartnerEventsRequestEntry) Validate added in v0.20.0 

func (s *PutPartnerEventsRequestEntry) Validate() error

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

type PutPartnerEventsResponse added in v0.10.0 

type PutPartnerEventsResponse struct {
	*PutPartnerEventsOutput
	// contains filtered or unexported fields
}

PutPartnerEventsResponse is the response type for the PutPartnerEvents API operation.

func (*PutPartnerEventsResponse) SDKResponseMetdata added in v0.10.0 

func (r *PutPartnerEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutPartnerEvents request.

type PutPartnerEventsResultEntry added in v0.10.0 

type PutPartnerEventsResultEntry struct {

	// The error code that indicates why the event submission failed.
	ErrorCode *string `type:"string"`

	// The error message that explains why the event submission failed.
	ErrorMessage *string `type:"string"`

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

Represents an event that a partner tried to generate, but failed.

func (PutPartnerEventsResultEntry) String added in v0.10.0 

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

	// This parameter enables you to limit the permission to accounts that fulfill
	// a certain condition, such as being a member of a certain AWS organization.
	// For more information about AWS Organizations, see What Is AWS Organizations
	// (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html)
	// in the AWS Organizations User Guide.
	//
	// If you specify Condition with an AWS organization ID, and specify "*" as
	// the value for Principal, you grant permission to all the accounts in the
	// named organization.
	//
	// The Condition is a JSON string which must contain Type, Key, and Value fields.
	Condition *Condition `type:"structure"`

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

	// The 12-digit AWS account ID that you are permitting to put events to your
	// default event bus. Specify "*" to permit any account to put events to your
	// default event bus.
	//
	// If you specify "*" without specifying Condition, avoid creating rules that
	// 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) 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) String 

func (s PutPermissionOutput) String() string

String returns the string representation

type PutPermissionRequest 

type PutPermissionRequest struct {
	*aws.Request
	Input *PutPermissionInput
	Copy  func(*PutPermissionInput) PutPermissionRequest
}

PutPermissionRequest is the request type for the PutPermission API operation.

func (PutPermissionRequest) Send 

func (r PutPermissionRequest) Send(ctx context.Context) (*PutPermissionResponse, error)

Send marshals and sends the PutPermission API request.

type PutPermissionResponse added in v0.9.0 

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

PutPermissionResponse is the response type for the PutPermission API operation.

func (*PutPermissionResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutPermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutPermission request.

type PutRuleInput 

type PutRuleInput struct {

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

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

	// The event pattern. For more information, see Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	EventPattern *string `type:"string"`

	// The name of the rule that you 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 RuleState `type:"string" enum:"true"`

	// The list of key-value pairs to associate with the rule.
	Tags []Tag `type:"list"`
	// contains filtered or unexported fields
}

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

func (s PutRuleOutput) String() string

String returns the string representation

type PutRuleRequest 

type PutRuleRequest struct {
	*aws.Request
	Input *PutRuleInput
	Copy  func(*PutRuleInput) PutRuleRequest
}

PutRuleRequest is the request type for the PutRule API operation.

func (PutRuleRequest) Send 

func (r PutRuleRequest) Send(ctx context.Context) (*PutRuleResponse, error)

Send marshals and sends the PutRule API request.

type PutRuleResponse added in v0.9.0 

type PutRuleResponse struct {
	*PutRuleOutput
	// contains filtered or unexported fields
}

PutRuleResponse is the response type for the PutRule API operation.

func (*PutRuleResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutRuleResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutRule request.

type PutTargetsInput 

type PutTargetsInput struct {

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

	// The name of the rule.
	//
	// Rule is a required field
	Rule *string `min:"1" type:"string" required:"true"`

	// The targets to update or add to the rule.
	//
	// Targets is a required field
	Targets []Target `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutTargetsInput) 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) String 

func (s PutTargetsOutput) String() string

String returns the string representation

type PutTargetsRequest 

type PutTargetsRequest struct {
	*aws.Request
	Input *PutTargetsInput
	Copy  func(*PutTargetsInput) PutTargetsRequest
}

PutTargetsRequest is the request type for the PutTargets API operation.

func (PutTargetsRequest) Send 

func (r PutTargetsRequest) Send(ctx context.Context) (*PutTargetsResponse, error)

Send marshals and sends the PutTargets API request.

type PutTargetsResponse added in v0.9.0 

type PutTargetsResponse struct {
	*PutTargetsOutput
	// contains filtered or unexported fields
}

PutTargetsResponse is the response type for the PutTargets API operation.

func (*PutTargetsResponse) SDKResponseMetdata added in v0.9.0 

func (r *PutTargetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PutTargets request.

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

func (s PutTargetsResultEntry) String() string

String returns the string representation

type RemovePermissionInput 

type RemovePermissionInput struct {

	// The name of the event bus to revoke permissions for. If you omit this, the
	// default event bus is used.
	EventBusName *string `min:"1" type:"string"`

	// The statement ID corresponding to the account that is no longer allowed to
	// put events to the default event bus.
	//
	// StatementId is a required field
	StatementId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemovePermissionInput) 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) String 

func (s RemovePermissionOutput) String() string

String returns the string representation

type RemovePermissionRequest 

type RemovePermissionRequest struct {
	*aws.Request
	Input *RemovePermissionInput
	Copy  func(*RemovePermissionInput) RemovePermissionRequest
}

RemovePermissionRequest is the request type for the RemovePermission API operation.

func (RemovePermissionRequest) Send 

func (r RemovePermissionRequest) Send(ctx context.Context) (*RemovePermissionResponse, error)

Send marshals and sends the RemovePermission API request.

type RemovePermissionResponse added in v0.9.0 

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

RemovePermissionResponse is the response type for the RemovePermission API operation.

func (*RemovePermissionResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemovePermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemovePermission request.

type RemoveTargetsInput 

type RemoveTargetsInput struct {

	// The name of the event bus associated with the rule.
	EventBusName *string `min:"1" type:"string"`

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

	// The 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) 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) String 

func (s RemoveTargetsOutput) String() string

String returns the string representation

type RemoveTargetsRequest 

type RemoveTargetsRequest struct {
	*aws.Request
	Input *RemoveTargetsInput
	Copy  func(*RemoveTargetsInput) RemoveTargetsRequest
}

RemoveTargetsRequest is the request type for the RemoveTargets API operation.

func (RemoveTargetsRequest) Send 

func (r RemoveTargetsRequest) Send(ctx context.Context) (*RemoveTargetsResponse, error)

Send marshals and sends the RemoveTargets API request.

type RemoveTargetsResponse added in v0.9.0 

type RemoveTargetsResponse struct {
	*RemoveTargetsOutput
	// contains filtered or unexported fields
}

RemoveTargetsResponse is the response type for the RemoveTargets API operation.

func (*RemoveTargetsResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemoveTargetsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveTargets request.

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

func (s RemoveTargetsResultEntry) String() string

String returns the string representation

type Rule 

type Rule struct {

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

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

	// The event bus associated with the rule.
	EventBusName *string `min:"1" type:"string"`

	// The event pattern of the rule. For more information, see Events and Event
	// Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	EventPattern *string `type:"string"`

	// If the rule was created on behalf of your account by an AWS service, this
	// field displays the principal name of the service that created the rule.
	ManagedBy *string `min:"1" type:"string"`

	// The name of the rule.
	Name *string `min:"1" type:"string"`

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

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

	// The state of the rule.
	State RuleState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Contains information about a rule in Amazon EventBridge.

func (Rule) String 

func (s Rule) String() string

String returns the string representation

type RuleState 

type RuleState string
const (
	RuleStateEnabled  RuleState = "ENABLED"
	RuleStateDisabled RuleState = "DISABLED"
)

Enum values for RuleState

func (RuleState) MarshalValue added in v0.3.0 

func (enum RuleState) MarshalValue() (string, error)

func (RuleState) MarshalValueBuf added in v0.3.0 

func (enum RuleState) MarshalValueBuf(b []byte) ([]byte, error)

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) 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) 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 added in v0.4.0 

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) String added in v0.4.0 

func (s SqsParameters) String() string

String returns the string representation

type Tag added in v0.8.0 

type Tag struct {

	// A string you can use to assign a value. The combination of tag keys and values
	// can help you organize and categorize your resources.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value for the specified tag key.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A key-value pair associated with an AWS resource. In EventBridge, rules and event buses support tagging.

func (Tag) String added in v0.8.0 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v0.8.0 

func (s *Tag) Validate() error

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

type TagResourceInput added in v0.8.0 

type TagResourceInput struct {

	// The ARN of the EventBridge resource that you're adding tags to.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The list of key-value pairs to associate with the resource.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.8.0 

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

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type Target 

type Target struct {

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

	// If the event target is an AWS Batch job, this contains the job definition,
	// job name, and other parameters. For more information, see Jobs (https://docs.aws.amazon.com/batch/latest/userguide/jobs.html)
	// in the AWS Batch User Guide.
	BatchParameters *BatchParameters `type:"structure"`

	// Contains the Amazon ECS task definition and task count to be used, if the
	// event target is an Amazon ECS task. For more information about Amazon ECS
	// tasks, see Task Definitions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html)
	// in the Amazon EC2 Container Service Developer Guide.
	EcsParameters *EcsParameters `type:"structure"`

	// Contains the HTTP parameters to use when the target is a API Gateway REST
	// endpoint.
	//
	// If you specify an API Gateway REST API as a target, you can use this parameter
	// to specify headers, path parameter, query string keys/values as part of your
	// target invoking request.
	HttpParameters *HttpParameters `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 the shard assignment, when the
	// target is a Kinesis data 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.
	//
	// If you specify an SQS FIFO queue as a target, the queue must have content-based
	// deduplication enabled.
	SqsParameters *SqsParameters `type:"structure"`
	// contains filtered or unexported fields
}

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

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

func (Target) 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 (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)
	// in the Amazon EventBridge User Guide.
	//
	// EventPattern is a required field
	EventPattern *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TestEventPatternInput) 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) String 

func (s TestEventPatternOutput) String() string

String returns the string representation

type TestEventPatternRequest 

type TestEventPatternRequest struct {
	*aws.Request
	Input *TestEventPatternInput
	Copy  func(*TestEventPatternInput) TestEventPatternRequest
}

TestEventPatternRequest is the request type for the TestEventPattern API operation.

func (TestEventPatternRequest) Send 

func (r TestEventPatternRequest) Send(ctx context.Context) (*TestEventPatternResponse, error)

Send marshals and sends the TestEventPattern API request.

type TestEventPatternResponse added in v0.9.0 

type TestEventPatternResponse struct {
	*TestEventPatternOutput
	// contains filtered or unexported fields
}

TestEventPatternResponse is the response type for the TestEventPattern API operation.

func (*TestEventPatternResponse) SDKResponseMetdata added in v0.9.0 

func (r *TestEventPatternResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TestEventPattern request.

type UntagResourceInput added in v0.8.0 

type UntagResourceInput struct {

	// The ARN of the EventBridge resource from which you are removing tags.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The list of tag keys to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.8.0 

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

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

Source Files

View all Source files

Directories

Path Synopsis
Package cloudwatcheventsiface provides an interface to enable mocking the Amazon CloudWatch Events service client for testing your code.
 Package cloudwatcheventsiface provides an interface to enable mocking the Amazon CloudWatch Events service client for testing your code.

Jump to

Keyboard shortcuts

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