cloudwatchevents

package
v1.55.5 Latest Latest
Warning

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

 Go to latest Published: Jul 30, 2024 License: Apache-2.0 Imports: 10 Imported by: 343

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 Amazon Web Services resources. When your resources change state, they automatically send events to 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 Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.

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

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

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

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

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

Using the Client

To contact Amazon CloudWatch Events with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

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

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

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

Index

Constants

View Source 
const (
	// ApiDestinationHttpMethodPost is a ApiDestinationHttpMethod enum value
	ApiDestinationHttpMethodPost = "POST"

	// ApiDestinationHttpMethodGet is a ApiDestinationHttpMethod enum value
	ApiDestinationHttpMethodGet = "GET"

	// ApiDestinationHttpMethodHead is a ApiDestinationHttpMethod enum value
	ApiDestinationHttpMethodHead = "HEAD"

	// ApiDestinationHttpMethodOptions is a ApiDestinationHttpMethod enum value
	ApiDestinationHttpMethodOptions = "OPTIONS"

	// ApiDestinationHttpMethodPut is a ApiDestinationHttpMethod enum value
	ApiDestinationHttpMethodPut = "PUT"

	// ApiDestinationHttpMethodPatch is a ApiDestinationHttpMethod enum value
	ApiDestinationHttpMethodPatch = "PATCH"

	// ApiDestinationHttpMethodDelete is a ApiDestinationHttpMethod enum value
	ApiDestinationHttpMethodDelete = "DELETE"
)
View Source 
const (
	// ApiDestinationStateActive is a ApiDestinationState enum value
	ApiDestinationStateActive = "ACTIVE"

	// ApiDestinationStateInactive is a ApiDestinationState enum value
	ApiDestinationStateInactive = "INACTIVE"
)
View Source 
const (
	// ArchiveStateEnabled is a ArchiveState enum value
	ArchiveStateEnabled = "ENABLED"

	// ArchiveStateDisabled is a ArchiveState enum value
	ArchiveStateDisabled = "DISABLED"

	// ArchiveStateCreating is a ArchiveState enum value
	ArchiveStateCreating = "CREATING"

	// ArchiveStateUpdating is a ArchiveState enum value
	ArchiveStateUpdating = "UPDATING"

	// ArchiveStateCreateFailed is a ArchiveState enum value
	ArchiveStateCreateFailed = "CREATE_FAILED"

	// ArchiveStateUpdateFailed is a ArchiveState enum value
	ArchiveStateUpdateFailed = "UPDATE_FAILED"
)
View Source 
const (
	// AssignPublicIpEnabled is a AssignPublicIp enum value
	AssignPublicIpEnabled = "ENABLED"

	// AssignPublicIpDisabled is a AssignPublicIp enum value
	AssignPublicIpDisabled = "DISABLED"
)
View Source 
const (
	// ConnectionAuthorizationTypeBasic is a ConnectionAuthorizationType enum value
	ConnectionAuthorizationTypeBasic = "BASIC"

	// ConnectionAuthorizationTypeOauthClientCredentials is a ConnectionAuthorizationType enum value
	ConnectionAuthorizationTypeOauthClientCredentials = "OAUTH_CLIENT_CREDENTIALS"

	// ConnectionAuthorizationTypeApiKey is a ConnectionAuthorizationType enum value
	ConnectionAuthorizationTypeApiKey = "API_KEY"
)
View Source 
const (
	// ConnectionOAuthHttpMethodGet is a ConnectionOAuthHttpMethod enum value
	ConnectionOAuthHttpMethodGet = "GET"

	// ConnectionOAuthHttpMethodPost is a ConnectionOAuthHttpMethod enum value
	ConnectionOAuthHttpMethodPost = "POST"

	// ConnectionOAuthHttpMethodPut is a ConnectionOAuthHttpMethod enum value
	ConnectionOAuthHttpMethodPut = "PUT"
)
View Source 
const (
	// ConnectionStateCreating is a ConnectionState enum value
	ConnectionStateCreating = "CREATING"

	// ConnectionStateUpdating is a ConnectionState enum value
	ConnectionStateUpdating = "UPDATING"

	// ConnectionStateDeleting is a ConnectionState enum value
	ConnectionStateDeleting = "DELETING"

	// ConnectionStateAuthorized is a ConnectionState enum value
	ConnectionStateAuthorized = "AUTHORIZED"

	// ConnectionStateDeauthorized is a ConnectionState enum value
	ConnectionStateDeauthorized = "DEAUTHORIZED"

	// ConnectionStateAuthorizing is a ConnectionState enum value
	ConnectionStateAuthorizing = "AUTHORIZING"

	// ConnectionStateDeauthorizing is a ConnectionState enum value
	ConnectionStateDeauthorizing = "DEAUTHORIZING"
)
View Source 
const (
	// EventSourceStatePending is a EventSourceState enum value
	EventSourceStatePending = "PENDING"

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

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

	// LaunchTypeFargate is a LaunchType enum value
	LaunchTypeFargate = "FARGATE"

	// LaunchTypeExternal is a LaunchType enum value
	LaunchTypeExternal = "EXTERNAL"
)
View Source 
const (
	// PlacementConstraintTypeDistinctInstance is a PlacementConstraintType enum value
	PlacementConstraintTypeDistinctInstance = "distinctInstance"

	// PlacementConstraintTypeMemberOf is a PlacementConstraintType enum value
	PlacementConstraintTypeMemberOf = "memberOf"
)
View Source 
const (
	// PlacementStrategyTypeRandom is a PlacementStrategyType enum value
	PlacementStrategyTypeRandom = "random"

	// PlacementStrategyTypeSpread is a PlacementStrategyType enum value
	PlacementStrategyTypeSpread = "spread"

	// PlacementStrategyTypeBinpack is a PlacementStrategyType enum value
	PlacementStrategyTypeBinpack = "binpack"
)
View Source 
const (
	// ReplayStateStarting is a ReplayState enum value
	ReplayStateStarting = "STARTING"

	// ReplayStateRunning is a ReplayState enum value
	ReplayStateRunning = "RUNNING"

	// ReplayStateCancelling is a ReplayState enum value
	ReplayStateCancelling = "CANCELLING"

	// ReplayStateCompleted is a ReplayState enum value
	ReplayStateCompleted = "COMPLETED"

	// ReplayStateCancelled is a ReplayState enum value
	ReplayStateCancelled = "CANCELLED"

	// ReplayStateFailed is a ReplayState enum value
	ReplayStateFailed = "FAILED"
)
View Source 
const (
	// RuleStateEnabled is a RuleState enum value
	RuleStateEnabled = "ENABLED"

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

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// There is concurrent modification on a rule, target, archive, or replay.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeIllegalStatusException for service response error code
	// "IllegalStatusException".
	//
	// An error occurred because a replay can be canceled only when the state is
	// Running or Starting.
	ErrCodeIllegalStatusException = "IllegalStatusException"

	// 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".
	//
	// The request failed because it attempted to create resource beyond the allowed
	// service quota.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeManagedRuleException for service response error code
	// "ManagedRuleException".
	//
	// This rule was created by an Amazon Web Services 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"
)
View Source 
const (
	ServiceName = "events"            // Name of service.
	EndpointsID = ServiceName         // ID to lookup a service endpoint with.
	ServiceID   = "CloudWatch Events" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// PropagateTagsTaskDefinition is a PropagateTags enum value
	PropagateTagsTaskDefinition = "TASK_DEFINITION"
)

Variables

This section is empty.

Functions

func ApiDestinationHttpMethod_Values added in v1.37.24 

func ApiDestinationHttpMethod_Values() []string

ApiDestinationHttpMethod_Values returns all elements of the ApiDestinationHttpMethod enum

func ApiDestinationState_Values added in v1.37.24 

func ApiDestinationState_Values() []string

ApiDestinationState_Values returns all elements of the ApiDestinationState enum

func ArchiveState_Values added in v1.35.22 

func ArchiveState_Values() []string

ArchiveState_Values returns all elements of the ArchiveState enum

func AssignPublicIp_Values added in v1.34.3 

func AssignPublicIp_Values() []string

AssignPublicIp_Values returns all elements of the AssignPublicIp enum

func ConnectionAuthorizationType_Values added in v1.37.24 

func ConnectionAuthorizationType_Values() []string

ConnectionAuthorizationType_Values returns all elements of the ConnectionAuthorizationType enum

func ConnectionOAuthHttpMethod_Values added in v1.37.24 

func ConnectionOAuthHttpMethod_Values() []string

ConnectionOAuthHttpMethod_Values returns all elements of the ConnectionOAuthHttpMethod enum

func ConnectionState_Values added in v1.37.24 

func ConnectionState_Values() []string

ConnectionState_Values returns all elements of the ConnectionState enum

func EventSourceState_Values added in v1.34.3 

func EventSourceState_Values() []string

EventSourceState_Values returns all elements of the EventSourceState enum

func LaunchType_Values added in v1.34.3 

func LaunchType_Values() []string

LaunchType_Values returns all elements of the LaunchType enum

func PlacementConstraintType_Values added in v1.38.66 

func PlacementConstraintType_Values() []string

PlacementConstraintType_Values returns all elements of the PlacementConstraintType enum

func PlacementStrategyType_Values added in v1.38.66 

func PlacementStrategyType_Values() []string

PlacementStrategyType_Values returns all elements of the PlacementStrategyType enum

func PropagateTags_Values added in v1.38.66 

func PropagateTags_Values() []string

PropagateTags_Values returns all elements of the PropagateTags enum

func ReplayState_Values added in v1.35.22 

func ReplayState_Values() []string

ReplayState_Values returns all elements of the ReplayState enum

func RuleState_Values added in v1.34.3 

func RuleState_Values() []string

RuleState_Values returns all elements of the RuleState enum

Types

type ActivateEventSourceInput added in v1.20.19 

type ActivateEventSourceInput struct {

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

func (ActivateEventSourceInput) GoString added in v1.20.19 

func (s ActivateEventSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateEventSourceInput) SetName added in v1.20.19 

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

SetName sets the Name field's value.

func (ActivateEventSourceInput) String added in v1.20.19 

func (s ActivateEventSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActivateEventSourceInput) Validate added in v1.20.19 

func (s *ActivateEventSourceInput) Validate() error

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

type ActivateEventSourceOutput added in v1.20.19 

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

func (ActivateEventSourceOutput) GoString added in v1.20.19 

func (s ActivateEventSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ActivateEventSourceOutput) String added in v1.20.19 

func (s ActivateEventSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApiDestination added in v1.37.24 

type ApiDestination struct {

	// The ARN of the API destination.
	ApiDestinationArn *string `min:"1" type:"string"`

	// The state of the API destination.
	ApiDestinationState *string `type:"string" enum:"ApiDestinationState"`

	// The ARN of the connection specified for the API destination.
	ConnectionArn *string `min:"1" type:"string"`

	// A time stamp for the time that the API destination was created.
	CreationTime *time.Time `type:"timestamp"`

	// The method to use to connect to the HTTP endpoint.
	HttpMethod *string `type:"string" enum:"ApiDestinationHttpMethod"`

	// The URL to the endpoint for the API destination.
	InvocationEndpoint *string `min:"1" type:"string"`

	// The maximum number of invocations per second to send to the HTTP endpoint.
	InvocationRateLimitPerSecond *int64 `min:"1" type:"integer"`

	// A time stamp for the time that the API destination was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the API destination.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains details about an API destination.

func (ApiDestination) GoString added in v1.37.24 

func (s ApiDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApiDestination) SetApiDestinationArn added in v1.37.24 

func (s *ApiDestination) SetApiDestinationArn(v string) *ApiDestination

SetApiDestinationArn sets the ApiDestinationArn field's value.

func (*ApiDestination) SetApiDestinationState added in v1.37.24 

func (s *ApiDestination) SetApiDestinationState(v string) *ApiDestination

SetApiDestinationState sets the ApiDestinationState field's value.

func (*ApiDestination) SetConnectionArn added in v1.37.24 

func (s *ApiDestination) SetConnectionArn(v string) *ApiDestination

SetConnectionArn sets the ConnectionArn field's value.

func (*ApiDestination) SetCreationTime added in v1.37.24 

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

SetCreationTime sets the CreationTime field's value.

func (*ApiDestination) SetHttpMethod added in v1.37.24 

func (s *ApiDestination) SetHttpMethod(v string) *ApiDestination

SetHttpMethod sets the HttpMethod field's value.

func (*ApiDestination) SetInvocationEndpoint added in v1.37.24 

func (s *ApiDestination) SetInvocationEndpoint(v string) *ApiDestination

SetInvocationEndpoint sets the InvocationEndpoint field's value.

func (*ApiDestination) SetInvocationRateLimitPerSecond added in v1.37.24 

func (s *ApiDestination) SetInvocationRateLimitPerSecond(v int64) *ApiDestination

SetInvocationRateLimitPerSecond sets the InvocationRateLimitPerSecond field's value.

func (*ApiDestination) SetLastModifiedTime added in v1.37.24 

func (s *ApiDestination) SetLastModifiedTime(v time.Time) *ApiDestination

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*ApiDestination) SetName added in v1.37.24 

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

SetName sets the Name field's value.

func (ApiDestination) String added in v1.37.24 

func (s ApiDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Archive added in v1.35.22 

type Archive struct {

	// The name of the archive.
	ArchiveName *string `min:"1" type:"string"`

	// The time stamp for the time that the archive was created.
	CreationTime *time.Time `type:"timestamp"`

	// The number of events in the archive.
	EventCount *int64 `type:"long"`

	// The ARN of the event bus associated with the archive. Only events from this
	// event bus are sent to the archive.
	EventSourceArn *string `min:"1" type:"string"`

	// The number of days to retain events in the archive before they are deleted.
	RetentionDays *int64 `type:"integer"`

	// The size of the archive, in bytes.
	SizeBytes *int64 `type:"long"`

	// The current state of the archive.
	State *string `type:"string" enum:"ArchiveState"`

	// A description for the reason that the archive is in the current state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

An Archive object that contains details about an archive.

func (Archive) GoString added in v1.35.22 

func (s Archive) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Archive) SetArchiveName added in v1.35.22 

func (s *Archive) SetArchiveName(v string) *Archive

SetArchiveName sets the ArchiveName field's value.

func (*Archive) SetCreationTime added in v1.35.22 

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

SetCreationTime sets the CreationTime field's value.

func (*Archive) SetEventCount added in v1.35.22 

func (s *Archive) SetEventCount(v int64) *Archive

SetEventCount sets the EventCount field's value.

func (*Archive) SetEventSourceArn added in v1.35.22 

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

SetEventSourceArn sets the EventSourceArn field's value.

func (*Archive) SetRetentionDays added in v1.35.22 

func (s *Archive) SetRetentionDays(v int64) *Archive

SetRetentionDays sets the RetentionDays field's value.

func (*Archive) SetSizeBytes added in v1.35.22 

func (s *Archive) SetSizeBytes(v int64) *Archive

SetSizeBytes sets the SizeBytes field's value.

func (*Archive) SetState added in v1.35.22 

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

SetState sets the State field's value.

func (*Archive) SetStateReason added in v1.35.22 

func (s *Archive) SetStateReason(v string) *Archive

SetStateReason sets the StateReason field's value.

func (Archive) String added in v1.35.22 

func (s Archive) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsVpcConfiguration added in v1.15.20 

type AwsVpcConfiguration struct {

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

	// Specifies the security groups associated with the task. These security groups
	// must all be in the same VPC. You can specify as many as five security groups.
	// If you 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) GoString added in v1.15.20 

func (s AwsVpcConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsVpcConfiguration) SetAssignPublicIp added in v1.15.20 

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

SetAssignPublicIp sets the AssignPublicIp field's value.

func (*AwsVpcConfiguration) SetSecurityGroups added in v1.15.20 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsVpcConfiguration) SetSubnets added in v1.15.20 

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

SetSubnets sets the Subnets field's value.

func (AwsVpcConfiguration) String added in v1.15.20 

func (s AwsVpcConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsVpcConfiguration) Validate added in v1.15.20 

func (s *AwsVpcConfiguration) Validate() error

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

type BatchArrayProperties added in v1.13.8 

type BatchArrayProperties struct {

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

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

func (BatchArrayProperties) GoString added in v1.13.8 

func (s BatchArrayProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchArrayProperties) SetSize added in v1.13.8 

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

SetSize sets the Size field's value.

func (BatchArrayProperties) String added in v1.13.8 

func (s BatchArrayProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchParameters added in v1.13.8 

type BatchParameters struct {

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

	// The ARN or name of the job definition to use if the event target is an 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 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 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 Batch job.

func (BatchParameters) GoString added in v1.13.8 

func (s BatchParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchParameters) SetArrayProperties added in v1.13.8 

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

SetArrayProperties sets the ArrayProperties field's value.

func (*BatchParameters) SetJobDefinition added in v1.13.8 

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

SetJobDefinition sets the JobDefinition field's value.

func (*BatchParameters) SetJobName added in v1.13.8 

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

SetJobName sets the JobName field's value.

func (*BatchParameters) SetRetryStrategy added in v1.13.8 

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

SetRetryStrategy sets the RetryStrategy field's value.

func (BatchParameters) String added in v1.13.8 

func (s BatchParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchParameters) Validate added in v1.13.8 

func (s *BatchParameters) Validate() error

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

type BatchRetryStrategy added in v1.13.8 

type BatchRetryStrategy struct {

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

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

func (BatchRetryStrategy) GoString added in v1.13.8 

func (s BatchRetryStrategy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchRetryStrategy) SetAttempts added in v1.13.8 

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

SetAttempts sets the Attempts field's value.

func (BatchRetryStrategy) String added in v1.13.8 

func (s BatchRetryStrategy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelReplayInput added in v1.35.22 

type CancelReplayInput struct {

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

func (CancelReplayInput) GoString added in v1.35.22 

func (s CancelReplayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelReplayInput) SetReplayName added in v1.35.22 

func (s *CancelReplayInput) SetReplayName(v string) *CancelReplayInput

SetReplayName sets the ReplayName field's value.

func (CancelReplayInput) String added in v1.35.22 

func (s CancelReplayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelReplayInput) Validate added in v1.35.22 

func (s *CancelReplayInput) Validate() error

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

type CancelReplayOutput added in v1.35.22 

type CancelReplayOutput struct {

	// The ARN of the replay to cancel.
	ReplayArn *string `min:"1" type:"string"`

	// The current state of the replay.
	State *string `type:"string" enum:"ReplayState"`

	// The reason that the replay is in the current state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (CancelReplayOutput) GoString added in v1.35.22 

func (s CancelReplayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelReplayOutput) SetReplayArn added in v1.35.22 

func (s *CancelReplayOutput) SetReplayArn(v string) *CancelReplayOutput

SetReplayArn sets the ReplayArn field's value.

func (*CancelReplayOutput) SetState added in v1.35.22 

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

SetState sets the State field's value.

func (*CancelReplayOutput) SetStateReason added in v1.35.22 

func (s *CancelReplayOutput) SetStateReason(v string) *CancelReplayOutput

SetStateReason sets the StateReason field's value.

func (CancelReplayOutput) String added in v1.35.22 

func (s CancelReplayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityProviderStrategyItem added in v1.38.66 

type CapacityProviderStrategyItem struct {

	// The base value designates how many tasks, at a minimum, to run on the specified
	// capacity provider. Only one capacity provider in a capacity provider strategy
	// can have a base defined. If no value is specified, the default value of 0
	// is used.
	Base *int64 `locationName:"base" type:"integer"`

	// The short name of the capacity provider.
	//
	// CapacityProvider is a required field
	CapacityProvider *string `locationName:"capacityProvider" min:"1" type:"string" required:"true"`

	// The weight value designates the relative percentage of the total number of
	// tasks launched that should use the specified capacity provider. The weight
	// value is taken into consideration after the base value, if defined, is satisfied.
	Weight *int64 `locationName:"weight" type:"integer"`
	// contains filtered or unexported fields
}

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html) in the Amazon ECS API Reference.

func (CapacityProviderStrategyItem) GoString added in v1.38.66 

func (s CapacityProviderStrategyItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityProviderStrategyItem) SetBase added in v1.38.66 

func (s *CapacityProviderStrategyItem) SetBase(v int64) *CapacityProviderStrategyItem

SetBase sets the Base field's value.

func (*CapacityProviderStrategyItem) SetCapacityProvider added in v1.38.66 

func (s *CapacityProviderStrategyItem) SetCapacityProvider(v string) *CapacityProviderStrategyItem

SetCapacityProvider sets the CapacityProvider field's value.

func (*CapacityProviderStrategyItem) SetWeight added in v1.38.66 

func (s *CapacityProviderStrategyItem) SetWeight(v int64) *CapacityProviderStrategyItem

SetWeight sets the Weight field's value.

func (CapacityProviderStrategyItem) String added in v1.38.66 

func (s CapacityProviderStrategyItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityProviderStrategyItem) Validate added in v1.38.66 

func (s *CapacityProviderStrategyItem) Validate() error

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

type CloudWatchEvents 

type CloudWatchEvents struct {
	*client.Client
}

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

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

func New 

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

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

Example: 

mySession := session.Must(session.NewSession())

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

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

func (*CloudWatchEvents) ActivateEventSource added in v1.20.19 

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

ActivateEventSource API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • InvalidStateException The specified state is not a valid state for an event source.

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) ActivateEventSourceRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ActivateEventSourceWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) CancelReplay added in v1.35.22 

func (c *CloudWatchEvents) CancelReplay(input *CancelReplayInput) (*CancelReplayOutput, error)

CancelReplay API operation for Amazon CloudWatch Events.

Cancels the specified replay.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • IllegalStatusException An error occurred because a replay can be canceled only when the state is Running or Starting.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) CancelReplayRequest added in v1.35.22 

func (c *CloudWatchEvents) CancelReplayRequest(input *CancelReplayInput) (req *request.Request, output *CancelReplayOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) CancelReplayWithContext added in v1.35.22 

func (c *CloudWatchEvents) CancelReplayWithContext(ctx aws.Context, input *CancelReplayInput, opts ...request.Option) (*CancelReplayOutput, error)

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

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

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

func (*CloudWatchEvents) CreateApiDestination added in v1.37.24 

func (c *CloudWatchEvents) CreateApiDestination(input *CreateApiDestinationInput) (*CreateApiDestinationOutput, error)

CreateApiDestination API operation for Amazon CloudWatch Events.

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

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

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

Returned Error Types:

  • ResourceAlreadyExistsException The resource you are trying to create already exists.

  • ResourceNotFoundException An entity that you specified does not exist.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) CreateApiDestinationRequest added in v1.37.24 

func (c *CloudWatchEvents) CreateApiDestinationRequest(input *CreateApiDestinationInput) (req *request.Request, output *CreateApiDestinationOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) CreateApiDestinationWithContext added in v1.37.24 

func (c *CloudWatchEvents) CreateApiDestinationWithContext(ctx aws.Context, input *CreateApiDestinationInput, opts ...request.Option) (*CreateApiDestinationOutput, error)

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

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

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

func (*CloudWatchEvents) CreateArchive added in v1.35.22 

func (c *CloudWatchEvents) CreateArchive(input *CreateArchiveInput) (*CreateArchiveOutput, error)

CreateArchive API operation for Amazon CloudWatch Events.

Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

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

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

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceAlreadyExistsException The resource you are trying to create already exists.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • InvalidEventPatternException The event pattern is not valid.

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

func (*CloudWatchEvents) CreateArchiveRequest added in v1.35.22 

func (c *CloudWatchEvents) CreateArchiveRequest(input *CreateArchiveInput) (req *request.Request, output *CreateArchiveOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) CreateArchiveWithContext added in v1.35.22 

func (c *CloudWatchEvents) CreateArchiveWithContext(ctx aws.Context, input *CreateArchiveInput, opts ...request.Option) (*CreateArchiveOutput, error)

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

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

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

func (*CloudWatchEvents) CreateConnection added in v1.37.24 

func (c *CloudWatchEvents) CreateConnection(input *CreateConnectionInput) (*CreateConnectionOutput, error)

CreateConnection API operation for Amazon CloudWatch Events.

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

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

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

Returned Error Types:

  • ResourceAlreadyExistsException The resource you are trying to create already exists.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) CreateConnectionRequest added in v1.37.24 

func (c *CloudWatchEvents) CreateConnectionRequest(input *CreateConnectionInput) (req *request.Request, output *CreateConnectionOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) CreateConnectionWithContext added in v1.37.24 

func (c *CloudWatchEvents) CreateConnectionWithContext(ctx aws.Context, input *CreateConnectionInput, opts ...request.Option) (*CreateConnectionOutput, error)

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

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

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

func (*CloudWatchEvents) CreateEventBus added in v1.20.19 

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

CreateEventBus API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • ResourceAlreadyExistsException The resource you are trying to create already exists.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InvalidStateException The specified state is not a valid state for an event source.

  • InternalException This exception occurs due to unexpected causes.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) CreateEventBusRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) CreateEventBusWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) CreatePartnerEventSource added in v1.20.19 

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

CreatePartnerEventSource API operation for Amazon CloudWatch Events.

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

Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services customers decide whether to create an event bus to receive these events.

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

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

Returned Error Types:

  • ResourceAlreadyExistsException The resource you are trying to create already exists.

  • InternalException This exception occurs due to unexpected causes.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) CreatePartnerEventSourceRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) CreatePartnerEventSourceWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) DeactivateEventSource added in v1.20.19 

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

DeactivateEventSource 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html).

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • InvalidStateException The specified state is not a valid state for an event source.

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) DeactivateEventSourceRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeactivateEventSourceWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) DeauthorizeConnection added in v1.37.24 

func (c *CloudWatchEvents) DeauthorizeConnection(input *DeauthorizeConnectionInput) (*DeauthorizeConnectionOutput, error)

DeauthorizeConnection API operation for Amazon CloudWatch Events.

Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.

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

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

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DeauthorizeConnectionRequest added in v1.37.24 

func (c *CloudWatchEvents) DeauthorizeConnectionRequest(input *DeauthorizeConnectionInput) (req *request.Request, output *DeauthorizeConnectionOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeauthorizeConnectionWithContext added in v1.37.24 

func (c *CloudWatchEvents) DeauthorizeConnectionWithContext(ctx aws.Context, input *DeauthorizeConnectionInput, opts ...request.Option) (*DeauthorizeConnectionOutput, error)

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

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

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

func (*CloudWatchEvents) DeleteApiDestination added in v1.37.24 

func (c *CloudWatchEvents) DeleteApiDestination(input *DeleteApiDestinationInput) (*DeleteApiDestinationOutput, error)

DeleteApiDestination API operation for Amazon CloudWatch Events.

Deletes the specified API destination.

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

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

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DeleteApiDestinationRequest added in v1.37.24 

func (c *CloudWatchEvents) DeleteApiDestinationRequest(input *DeleteApiDestinationInput) (req *request.Request, output *DeleteApiDestinationOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeleteApiDestinationWithContext added in v1.37.24 

func (c *CloudWatchEvents) DeleteApiDestinationWithContext(ctx aws.Context, input *DeleteApiDestinationInput, opts ...request.Option) (*DeleteApiDestinationOutput, error)

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

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

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

func (*CloudWatchEvents) DeleteArchive added in v1.35.22 

func (c *CloudWatchEvents) DeleteArchive(input *DeleteArchiveInput) (*DeleteArchiveOutput, error)

DeleteArchive API operation for Amazon CloudWatch Events.

Deletes the specified archive.

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

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

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DeleteArchiveRequest added in v1.35.22 

func (c *CloudWatchEvents) DeleteArchiveRequest(input *DeleteArchiveInput) (req *request.Request, output *DeleteArchiveOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeleteArchiveWithContext added in v1.35.22 

func (c *CloudWatchEvents) DeleteArchiveWithContext(ctx aws.Context, input *DeleteArchiveInput, opts ...request.Option) (*DeleteArchiveOutput, error)

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

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

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

func (*CloudWatchEvents) DeleteConnection added in v1.37.24 

func (c *CloudWatchEvents) DeleteConnection(input *DeleteConnectionInput) (*DeleteConnectionOutput, error)

DeleteConnection API operation for Amazon CloudWatch Events.

Deletes a connection.

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

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

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DeleteConnectionRequest added in v1.37.24 

func (c *CloudWatchEvents) DeleteConnectionRequest(input *DeleteConnectionInput) (req *request.Request, output *DeleteConnectionOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeleteConnectionWithContext added in v1.37.24 

func (c *CloudWatchEvents) DeleteConnectionWithContext(ctx aws.Context, input *DeleteConnectionInput, opts ...request.Option) (*DeleteConnectionOutput, error)

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

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

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

func (*CloudWatchEvents) DeleteEventBus added in v1.20.19 

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

DeleteEventBus API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

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

func (*CloudWatchEvents) DeleteEventBusRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeleteEventBusWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) DeletePartnerEventSource added in v1.20.19 

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

DeletePartnerEventSource API operation for Amazon CloudWatch Events.

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

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

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) DeletePartnerEventSourceRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeletePartnerEventSourceWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) DeleteRule 

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

DeleteRule API operation for Amazon CloudWatch Events.

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using RemoveTargets (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html).

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.

If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services 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.

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

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

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

  • InternalException This exception occurs due to unexpected causes.

  • ResourceNotFoundException An entity that you specified does not exist.

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

func (*CloudWatchEvents) DeleteRuleRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DeleteRuleWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) DescribeApiDestination added in v1.37.24 

func (c *CloudWatchEvents) DescribeApiDestination(input *DescribeApiDestinationInput) (*DescribeApiDestinationOutput, error)

DescribeApiDestination API operation for Amazon CloudWatch Events.

Retrieves details about an API destination.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DescribeApiDestinationRequest added in v1.37.24 

func (c *CloudWatchEvents) DescribeApiDestinationRequest(input *DescribeApiDestinationInput) (req *request.Request, output *DescribeApiDestinationOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribeApiDestinationWithContext added in v1.37.24 

func (c *CloudWatchEvents) DescribeApiDestinationWithContext(ctx aws.Context, input *DescribeApiDestinationInput, opts ...request.Option) (*DescribeApiDestinationOutput, error)

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

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

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

func (*CloudWatchEvents) DescribeArchive added in v1.35.22 

func (c *CloudWatchEvents) DescribeArchive(input *DescribeArchiveInput) (*DescribeArchiveOutput, error)

DescribeArchive API operation for Amazon CloudWatch Events.

Retrieves details about an archive.

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

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

Returned Error Types:

  • ResourceAlreadyExistsException The resource you are trying to create already exists.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DescribeArchiveRequest added in v1.35.22 

func (c *CloudWatchEvents) DescribeArchiveRequest(input *DescribeArchiveInput) (req *request.Request, output *DescribeArchiveOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribeArchiveWithContext added in v1.35.22 

func (c *CloudWatchEvents) DescribeArchiveWithContext(ctx aws.Context, input *DescribeArchiveInput, opts ...request.Option) (*DescribeArchiveOutput, error)

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

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

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

func (*CloudWatchEvents) DescribeConnection added in v1.37.24 

func (c *CloudWatchEvents) DescribeConnection(input *DescribeConnectionInput) (*DescribeConnectionOutput, error)

DescribeConnection API operation for Amazon CloudWatch Events.

Retrieves details about a connection.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DescribeConnectionRequest added in v1.37.24 

func (c *CloudWatchEvents) DescribeConnectionRequest(input *DescribeConnectionInput) (req *request.Request, output *DescribeConnectionOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribeConnectionWithContext added in v1.37.24 

func (c *CloudWatchEvents) DescribeConnectionWithContext(ctx aws.Context, input *DescribeConnectionInput, opts ...request.Option) (*DescribeConnectionOutput, error)

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

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

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

func (*CloudWatchEvents) DescribeEventBus added in v1.10.5 

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

DescribeEventBus API operation for Amazon CloudWatch Events.

Displays details about an event bus in your account. This can include the external Amazon Web Services 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html).

For more information about partner event buses, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html).

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DescribeEventBusRequest added in v1.10.5 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribeEventBusWithContext added in v1.10.5 

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

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

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

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

func (*CloudWatchEvents) DescribeEventSource added in v1.20.19 

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

DescribeEventSource API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) DescribeEventSourceRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribeEventSourceWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) DescribePartnerEventSource added in v1.20.19 

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

DescribePartnerEventSource API operation for Amazon CloudWatch Events.

An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html) to see details about a partner event source that is shared with them.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) DescribePartnerEventSourceRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribePartnerEventSourceWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) DescribeReplay added in v1.35.22 

func (c *CloudWatchEvents) DescribeReplay(input *DescribeReplayInput) (*DescribeReplayOutput, error)

DescribeReplay API operation for Amazon CloudWatch Events.

Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DescribeReplayRequest added in v1.35.22 

func (c *CloudWatchEvents) DescribeReplayRequest(input *DescribeReplayInput) (req *request.Request, output *DescribeReplayOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribeReplayWithContext added in v1.35.22 

func (c *CloudWatchEvents) DescribeReplayWithContext(ctx aws.Context, input *DescribeReplayInput, opts ...request.Option) (*DescribeReplayOutput, error)

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

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

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

func (*CloudWatchEvents) DescribeRule 

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

DescribeRule API operation for Amazon CloudWatch Events.

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html).

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DescribeRuleRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DescribeRuleWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) DisableRule 

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

DisableRule API operation for Amazon CloudWatch Events.

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

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

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) DisableRuleRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) DisableRuleWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) EnableRule 

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

EnableRule API operation for Amazon CloudWatch Events.

Enables the specified rule. If the rule 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.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) EnableRuleRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) EnableRuleWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) ListApiDestinations added in v1.37.24 

func (c *CloudWatchEvents) ListApiDestinations(input *ListApiDestinationsInput) (*ListApiDestinationsOutput, error)

ListApiDestinations API operation for Amazon CloudWatch Events.

Retrieves a list of API destination in the account in the current Region.

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) ListApiDestinationsRequest added in v1.37.24 

func (c *CloudWatchEvents) ListApiDestinationsRequest(input *ListApiDestinationsInput) (req *request.Request, output *ListApiDestinationsOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListApiDestinationsWithContext added in v1.37.24 

func (c *CloudWatchEvents) ListApiDestinationsWithContext(ctx aws.Context, input *ListApiDestinationsInput, opts ...request.Option) (*ListApiDestinationsOutput, error)

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

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

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

func (*CloudWatchEvents) ListArchives added in v1.35.22 

func (c *CloudWatchEvents) ListArchives(input *ListArchivesInput) (*ListArchivesOutput, error)

ListArchives API operation for Amazon CloudWatch Events.

Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) ListArchivesRequest added in v1.35.22 

func (c *CloudWatchEvents) ListArchivesRequest(input *ListArchivesInput) (req *request.Request, output *ListArchivesOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListArchivesWithContext added in v1.35.22 

func (c *CloudWatchEvents) ListArchivesWithContext(ctx aws.Context, input *ListArchivesInput, opts ...request.Option) (*ListArchivesOutput, error)

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

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

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

func (*CloudWatchEvents) ListConnections added in v1.37.24 

func (c *CloudWatchEvents) ListConnections(input *ListConnectionsInput) (*ListConnectionsOutput, error)

ListConnections API operation for Amazon CloudWatch Events.

Retrieves a list of connections from the account.

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) ListConnectionsRequest added in v1.37.24 

func (c *CloudWatchEvents) ListConnectionsRequest(input *ListConnectionsInput) (req *request.Request, output *ListConnectionsOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListConnectionsWithContext added in v1.37.24 

func (c *CloudWatchEvents) ListConnectionsWithContext(ctx aws.Context, input *ListConnectionsInput, opts ...request.Option) (*ListConnectionsOutput, error)

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

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

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

func (*CloudWatchEvents) ListEventBuses added in v1.20.19 

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

ListEventBuses API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) ListEventBusesRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListEventBusesWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) ListEventSources added in v1.20.19 

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

ListEventSources API operation for Amazon CloudWatch Events.

You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html).

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) ListEventSourcesRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListEventSourcesWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) ListPartnerEventSourceAccounts added in v1.20.19 

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

ListPartnerEventSourceAccounts API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) ListPartnerEventSourceAccountsRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListPartnerEventSourceAccountsWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) ListPartnerEventSources added in v1.20.19 

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

ListPartnerEventSources API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) ListPartnerEventSourcesRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListPartnerEventSourcesWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) ListReplays added in v1.35.22 

func (c *CloudWatchEvents) ListReplays(input *ListReplaysInput) (*ListReplaysOutput, error)

ListReplays API operation for Amazon CloudWatch Events.

Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) ListReplaysRequest added in v1.35.22 

func (c *CloudWatchEvents) ListReplaysRequest(input *ListReplaysInput) (req *request.Request, output *ListReplaysOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListReplaysWithContext added in v1.35.22 

func (c *CloudWatchEvents) ListReplaysWithContext(ctx aws.Context, input *ListReplaysInput, opts ...request.Option) (*ListReplaysOutput, error)

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

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

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

func (*CloudWatchEvents) ListRuleNamesByTarget 

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

ListRuleNamesByTarget API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ResourceNotFoundException An entity that you specified does not exist.

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

func (*CloudWatchEvents) ListRuleNamesByTargetRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListRuleNamesByTargetWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) ListRules 

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

ListRules API operation for Amazon CloudWatch Events.

Lists your 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html).

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ResourceNotFoundException An entity that you specified does not exist.

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

func (*CloudWatchEvents) ListRulesRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListRulesWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) ListTagsForResource added in v1.19.0 

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

ListTagsForResource API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) ListTagsForResourceRequest added in v1.19.0 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListTagsForResourceWithContext added in v1.19.0 

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

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

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

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

func (*CloudWatchEvents) ListTargetsByRule 

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

ListTargetsByRule API operation for Amazon CloudWatch Events.

Lists the targets assigned to the specified rule.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) ListTargetsByRuleRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) ListTargetsByRuleWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) PutEvents 

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

PutEvents API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) PutEventsRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) PutEventsWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) PutPartnerEvents added in v1.20.19 

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

PutPartnerEvents API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) PutPartnerEventsRequest added in v1.20.19 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) PutPartnerEventsWithContext added in v1.20.19 

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

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

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

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

func (*CloudWatchEvents) PutPermission added in v1.10.5 

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

PutPermission API operation for Amazon CloudWatch Events.

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services 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 Amazon Web Services 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 event bus cannot exceed 10 KB in size.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

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

  • InternalException This exception occurs due to unexpected causes.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) PutPermissionRequest added in v1.10.5 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) PutPermissionWithContext added in v1.10.5 

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

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

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

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

func (*CloudWatchEvents) PutRule 

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

PutRule API operation for Amazon CloudWatch Events.

Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html).

A single rule watches for events from a single event bus. Events generated by Amazon Web Services 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html).

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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html) and UntagResource (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html).

Most services in Amazon Web Services 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).

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

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

Returned Error Types:

  • InvalidEventPatternException The event pattern is not valid.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

  • InternalException This exception occurs due to unexpected causes.

  • ResourceNotFoundException An entity that you specified does not exist.

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

func (*CloudWatchEvents) PutRuleRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) PutRuleWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) PutTargets 

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

PutTargets API operation for Amazon CloudWatch Events.

Adds the specified targets to the specified rule, or updates the targets if they 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:

  • API destination (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html)

  • Amazon API Gateway REST API endpoints

  • API Gateway

  • Batch job queue

  • CloudWatch Logs group

  • CodeBuild project

  • CodePipeline

  • Amazon EC2 CreateSnapshot API call

  • Amazon EC2 RebootInstances API call

  • Amazon EC2 StopInstances API call

  • Amazon EC2 TerminateInstances API call

  • Amazon ECS tasks

  • Event bus in a different Amazon Web Services account or Region. You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.

  • Firehose delivery stream (Kinesis Data Firehose)

  • Inspector assessment template (Amazon Inspector)

  • Kinesis stream (Kinesis Data Stream)

  • Lambda function

  • Redshift clusters (Data API statement execution)

  • Amazon SNS topic

  • Amazon SQS queues (includes FIFO queues

  • SSM Automation

  • SSM OpsItem

  • SSM Run Command

  • Step Functions state machines

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

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

To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, 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 Amazon Web Services 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 Pricing (http://aws.amazon.com/eventbridge/pricing/).

Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services 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 Amazon Web Services 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html).

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.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) PutTargetsRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) PutTargetsWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) RemovePermission added in v1.10.5 

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

RemovePermission API operation for Amazon CloudWatch Events.

Revokes the permission of another Amazon Web Services 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html).

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • OperationDisabledException The operation you are attempting is not available in this region.

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

func (*CloudWatchEvents) RemovePermissionRequest added in v1.10.5 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) RemovePermissionWithContext added in v1.10.5 

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

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

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

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

func (*CloudWatchEvents) RemoveTargets 

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

RemoveTargets API operation for Amazon CloudWatch Events.

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

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

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

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) RemoveTargetsRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) RemoveTargetsWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) StartReplay added in v1.35.22 

func (c *CloudWatchEvents) StartReplay(input *StartReplayInput) (*StartReplayOutput, error)

StartReplay API operation for Amazon CloudWatch Events.

Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ResourceAlreadyExistsException The resource you are trying to create already exists.

  • InvalidEventPatternException The event pattern is not valid.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) StartReplayRequest added in v1.35.22 

func (c *CloudWatchEvents) StartReplayRequest(input *StartReplayInput) (req *request.Request, output *StartReplayOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) StartReplayWithContext added in v1.35.22 

func (c *CloudWatchEvents) StartReplayWithContext(ctx aws.Context, input *StartReplayInput, opts ...request.Option) (*StartReplayOutput, error)

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

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

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

func (*CloudWatchEvents) TagResource added in v1.19.0 

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

TagResource API operation for Amazon CloudWatch Events.

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

Tags don't have any semantic meaning to Amazon Web Services 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.

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • InternalException This exception occurs due to unexpected causes.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

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

func (*CloudWatchEvents) TagResourceRequest added in v1.19.0 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) TagResourceWithContext added in v1.19.0 

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

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

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

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

func (*CloudWatchEvents) TestEventPattern 

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

TestEventPattern API operation for Amazon CloudWatch Events.

Tests whether the specified event pattern matches the provided event.

Most services in Amazon Web Services 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.

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

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

Returned Error Types:

  • InvalidEventPatternException The event pattern is not valid.

  • InternalException This exception occurs due to unexpected causes.

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

func (*CloudWatchEvents) TestEventPatternRequest 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) TestEventPatternWithContext added in v1.8.0 

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

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

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

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

func (*CloudWatchEvents) UntagResource added in v1.19.0 

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

UntagResource API operation for Amazon CloudWatch Events.

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

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

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

Returned Error Types:

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ManagedRuleException This rule was created by an Amazon Web Services 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.

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

func (*CloudWatchEvents) UntagResourceRequest added in v1.19.0 

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

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

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

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

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

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

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

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

func (*CloudWatchEvents) UntagResourceWithContext added in v1.19.0 

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

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

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

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

func (*CloudWatchEvents) UpdateApiDestination added in v1.37.24 

func (c *CloudWatchEvents) UpdateApiDestination(input *UpdateApiDestinationInput) (*UpdateApiDestinationOutput, error)

UpdateApiDestination API operation for Amazon CloudWatch Events.

Updates an API destination.

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

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

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

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

func (*CloudWatchEvents) UpdateApiDestinationRequest added in v1.37.24 

func (c *CloudWatchEvents) UpdateApiDestinationRequest(input *UpdateApiDestinationInput) (req *request.Request, output *UpdateApiDestinationOutput)

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

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

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

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

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

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

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

func (*CloudWatchEvents) UpdateApiDestinationWithContext added in v1.37.24 

func (c *CloudWatchEvents) UpdateApiDestinationWithContext(ctx aws.Context, input *UpdateApiDestinationInput, opts ...request.Option) (*UpdateApiDestinationOutput, error)

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

See UpdateApiDestination for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) UpdateArchive added in v1.35.22 

func (c *CloudWatchEvents) UpdateArchive(input *UpdateArchiveInput) (*UpdateArchiveOutput, error)

UpdateArchive API operation for Amazon CloudWatch Events.

Updates the specified archive.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation UpdateArchive for usage and error information.

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

  • InvalidEventPatternException The event pattern is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchive

func (*CloudWatchEvents) UpdateArchiveRequest added in v1.35.22 

func (c *CloudWatchEvents) UpdateArchiveRequest(input *UpdateArchiveInput) (req *request.Request, output *UpdateArchiveOutput)

UpdateArchiveRequest generates a "aws/request.Request" representing the client's request for the UpdateArchive operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateArchive for more information on using the UpdateArchive API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateArchiveRequest method.
req, resp := client.UpdateArchiveRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateArchive

func (*CloudWatchEvents) UpdateArchiveWithContext added in v1.35.22 

func (c *CloudWatchEvents) UpdateArchiveWithContext(ctx aws.Context, input *UpdateArchiveInput, opts ...request.Option) (*UpdateArchiveOutput, error)

UpdateArchiveWithContext is the same as UpdateArchive with the addition of the ability to pass a context and additional request options.

See UpdateArchive for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudWatchEvents) UpdateConnection added in v1.37.24 

func (c *CloudWatchEvents) UpdateConnection(input *UpdateConnectionInput) (*UpdateConnectionOutput, error)

UpdateConnection API operation for Amazon CloudWatch Events.

Updates settings for a connection.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudWatch Events's API operation UpdateConnection for usage and error information.

Returned Error Types:

  • ConcurrentModificationException There is concurrent modification on a rule, target, archive, or replay.

  • ResourceNotFoundException An entity that you specified does not exist.

  • InternalException This exception occurs due to unexpected causes.

  • LimitExceededException The request failed because it attempted to create resource beyond the allowed service quota.

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnection

func (*CloudWatchEvents) UpdateConnectionRequest added in v1.37.24 

func (c *CloudWatchEvents) UpdateConnectionRequest(input *UpdateConnectionInput) (req *request.Request, output *UpdateConnectionOutput)

UpdateConnectionRequest generates a "aws/request.Request" representing the client's request for the UpdateConnection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConnection for more information on using the UpdateConnection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateConnectionRequest method.
req, resp := client.UpdateConnectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/UpdateConnection

func (*CloudWatchEvents) UpdateConnectionWithContext added in v1.37.24 

func (c *CloudWatchEvents) UpdateConnectionWithContext(ctx aws.Context, input *UpdateConnectionInput, opts ...request.Option) (*UpdateConnectionOutput, error)

UpdateConnectionWithContext is the same as UpdateConnection with the addition of the ability to pass a context and additional request options.

See UpdateConnection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ConcurrentModificationException added in v1.28.0 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There is concurrent modification on a rule, target, archive, or replay.

func (*ConcurrentModificationException) Code added in v1.28.0 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error added in v1.28.0 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString added in v1.28.0 

func (s ConcurrentModificationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConcurrentModificationException) Message added in v1.28.0 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr added in v1.28.0 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID added in v1.28.0 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode added in v1.28.0 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String added in v1.28.0 

func (s ConcurrentModificationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Condition added in v1.15.57 

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 Amazon Web Services organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the Amazon Web Services organization. Following is an example value for Condition:

'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'

func (Condition) GoString added in v1.15.57 

func (s Condition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Condition) SetKey added in v1.15.57 

func (s *Condition) SetKey(v string) *Condition

SetKey sets the Key field's value.

func (*Condition) SetType added in v1.15.57 

func (s *Condition) SetType(v string) *Condition

SetType sets the Type field's value.

func (*Condition) SetValue added in v1.15.57 

func (s *Condition) SetValue(v string) *Condition

SetValue sets the Value field's value.

func (Condition) String added in v1.15.57 

func (s Condition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Condition) Validate added in v1.15.57 

func (s *Condition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Connection added in v1.37.24 

type Connection struct {

	// The authorization type specified for the connection.
	AuthorizationType *string `type:"string" enum:"ConnectionAuthorizationType"`

	// The ARN of the connection.
	ConnectionArn *string `min:"1" type:"string"`

	// The state of the connection.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// A time stamp for the time that the connection was created.
	CreationTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last authorized.
	LastAuthorizedTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the connection.
	Name *string `min:"1" type:"string"`

	// The reason that the connection is in the connection state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a connection.

func (Connection) GoString added in v1.37.24 

func (s Connection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Connection) SetAuthorizationType added in v1.37.24 

func (s *Connection) SetAuthorizationType(v string) *Connection

SetAuthorizationType sets the AuthorizationType field's value.

func (*Connection) SetConnectionArn added in v1.37.24 

func (s *Connection) SetConnectionArn(v string) *Connection

SetConnectionArn sets the ConnectionArn field's value.

func (*Connection) SetConnectionState added in v1.37.24 

func (s *Connection) SetConnectionState(v string) *Connection

SetConnectionState sets the ConnectionState field's value.

func (*Connection) SetCreationTime added in v1.37.24 

func (s *Connection) SetCreationTime(v time.Time) *Connection

SetCreationTime sets the CreationTime field's value.

func (*Connection) SetLastAuthorizedTime added in v1.37.24 

func (s *Connection) SetLastAuthorizedTime(v time.Time) *Connection

SetLastAuthorizedTime sets the LastAuthorizedTime field's value.

func (*Connection) SetLastModifiedTime added in v1.37.24 

func (s *Connection) SetLastModifiedTime(v time.Time) *Connection

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*Connection) SetName added in v1.37.24 

func (s *Connection) SetName(v string) *Connection

SetName sets the Name field's value.

func (*Connection) SetStateReason added in v1.37.24 

func (s *Connection) SetStateReason(v string) *Connection

SetStateReason sets the StateReason field's value.

func (Connection) String added in v1.37.24 

func (s Connection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionApiKeyAuthResponseParameters added in v1.37.24 

type ConnectionApiKeyAuthResponseParameters struct {

	// The name of the header to use for the APIKeyValue used for authorization.
	ApiKeyName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the authorization parameters for the connection if API Key is specified as the authorization type.

func (ConnectionApiKeyAuthResponseParameters) GoString added in v1.37.24 

func (s ConnectionApiKeyAuthResponseParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionApiKeyAuthResponseParameters) SetApiKeyName added in v1.37.24 

func (s *ConnectionApiKeyAuthResponseParameters) SetApiKeyName(v string) *ConnectionApiKeyAuthResponseParameters

SetApiKeyName sets the ApiKeyName field's value.

func (ConnectionApiKeyAuthResponseParameters) String added in v1.37.24 

func (s ConnectionApiKeyAuthResponseParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionAuthResponseParameters added in v1.37.24 

type ConnectionAuthResponseParameters struct {

	// The API Key parameters to use for authorization.
	ApiKeyAuthParameters *ConnectionApiKeyAuthResponseParameters `type:"structure"`

	// The authorization parameters for Basic authorization.
	BasicAuthParameters *ConnectionBasicAuthResponseParameters `type:"structure"`

	// Additional parameters for the connection that are passed through with every
	// invocation to the HTTP endpoint.
	InvocationHttpParameters *ConnectionHttpParameters `type:"structure"`

	// The OAuth parameters to use for authorization.
	OAuthParameters *ConnectionOAuthResponseParameters `type:"structure"`
	// contains filtered or unexported fields
}

Contains the authorization parameters to use for the connection.

func (ConnectionAuthResponseParameters) GoString added in v1.37.24 

func (s ConnectionAuthResponseParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionAuthResponseParameters) SetApiKeyAuthParameters added in v1.37.24 

func (s *ConnectionAuthResponseParameters) SetApiKeyAuthParameters(v *ConnectionApiKeyAuthResponseParameters) *ConnectionAuthResponseParameters

SetApiKeyAuthParameters sets the ApiKeyAuthParameters field's value.

func (*ConnectionAuthResponseParameters) SetBasicAuthParameters added in v1.37.24 

func (s *ConnectionAuthResponseParameters) SetBasicAuthParameters(v *ConnectionBasicAuthResponseParameters) *ConnectionAuthResponseParameters

SetBasicAuthParameters sets the BasicAuthParameters field's value.

func (*ConnectionAuthResponseParameters) SetInvocationHttpParameters added in v1.37.24 

func (s *ConnectionAuthResponseParameters) SetInvocationHttpParameters(v *ConnectionHttpParameters) *ConnectionAuthResponseParameters

SetInvocationHttpParameters sets the InvocationHttpParameters field's value.

func (*ConnectionAuthResponseParameters) SetOAuthParameters added in v1.37.24 

func (s *ConnectionAuthResponseParameters) SetOAuthParameters(v *ConnectionOAuthResponseParameters) *ConnectionAuthResponseParameters

SetOAuthParameters sets the OAuthParameters field's value.

func (ConnectionAuthResponseParameters) String added in v1.37.24 

func (s ConnectionAuthResponseParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionBasicAuthResponseParameters added in v1.37.24 

type ConnectionBasicAuthResponseParameters struct {

	// The user name to use for Basic authorization.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the authorization parameters for the connection if Basic is specified as the authorization type.

func (ConnectionBasicAuthResponseParameters) GoString added in v1.37.24 

func (s ConnectionBasicAuthResponseParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionBasicAuthResponseParameters) SetUsername added in v1.37.24 

func (s *ConnectionBasicAuthResponseParameters) SetUsername(v string) *ConnectionBasicAuthResponseParameters

SetUsername sets the Username field's value.

func (ConnectionBasicAuthResponseParameters) String added in v1.37.24 

func (s ConnectionBasicAuthResponseParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionBodyParameter added in v1.37.24 

type ConnectionBodyParameter struct {

	// Specified whether the value is secret.
	IsValueSecret *bool `type:"boolean"`

	// The key for the parameter.
	Key *string `type:"string"`

	// The value associated with the key.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ConnectionBodyParameter's
	// String and GoString methods.
	Value *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

func (ConnectionBodyParameter) GoString added in v1.37.24 

func (s ConnectionBodyParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionBodyParameter) SetIsValueSecret added in v1.37.24 

func (s *ConnectionBodyParameter) SetIsValueSecret(v bool) *ConnectionBodyParameter

SetIsValueSecret sets the IsValueSecret field's value.

func (*ConnectionBodyParameter) SetKey added in v1.37.24 

func (s *ConnectionBodyParameter) SetKey(v string) *ConnectionBodyParameter

SetKey sets the Key field's value.

func (*ConnectionBodyParameter) SetValue added in v1.37.24 

func (s *ConnectionBodyParameter) SetValue(v string) *ConnectionBodyParameter

SetValue sets the Value field's value.

func (ConnectionBodyParameter) String added in v1.37.24 

func (s ConnectionBodyParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionHeaderParameter added in v1.37.24 

type ConnectionHeaderParameter struct {

	// Specified whether the value is a secret.
	IsValueSecret *bool `type:"boolean"`

	// The key for the parameter.
	Key *string `type:"string"`

	// The value associated with the key.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ConnectionHeaderParameter's
	// String and GoString methods.
	Value *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

func (ConnectionHeaderParameter) GoString added in v1.37.24 

func (s ConnectionHeaderParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionHeaderParameter) SetIsValueSecret added in v1.37.24 

func (s *ConnectionHeaderParameter) SetIsValueSecret(v bool) *ConnectionHeaderParameter

SetIsValueSecret sets the IsValueSecret field's value.

func (*ConnectionHeaderParameter) SetKey added in v1.37.24 

func (s *ConnectionHeaderParameter) SetKey(v string) *ConnectionHeaderParameter

SetKey sets the Key field's value.

func (*ConnectionHeaderParameter) SetValue added in v1.37.24 

func (s *ConnectionHeaderParameter) SetValue(v string) *ConnectionHeaderParameter

SetValue sets the Value field's value.

func (ConnectionHeaderParameter) String added in v1.37.24 

func (s ConnectionHeaderParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionHttpParameters added in v1.37.24 

type ConnectionHttpParameters struct {

	// Contains additional body string parameters for the connection.
	BodyParameters []*ConnectionBodyParameter `type:"list"`

	// Contains additional header parameters for the connection.
	HeaderParameters []*ConnectionHeaderParameter `type:"list"`

	// Contains additional query string parameters for the connection.
	QueryStringParameters []*ConnectionQueryStringParameter `type:"list"`
	// contains filtered or unexported fields
}

Contains additional parameters for the connection.

func (ConnectionHttpParameters) GoString added in v1.37.24 

func (s ConnectionHttpParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionHttpParameters) SetBodyParameters added in v1.37.24 

func (s *ConnectionHttpParameters) SetBodyParameters(v []*ConnectionBodyParameter) *ConnectionHttpParameters

SetBodyParameters sets the BodyParameters field's value.

func (*ConnectionHttpParameters) SetHeaderParameters added in v1.37.24 

func (s *ConnectionHttpParameters) SetHeaderParameters(v []*ConnectionHeaderParameter) *ConnectionHttpParameters

SetHeaderParameters sets the HeaderParameters field's value.

func (*ConnectionHttpParameters) SetQueryStringParameters added in v1.37.24 

func (s *ConnectionHttpParameters) SetQueryStringParameters(v []*ConnectionQueryStringParameter) *ConnectionHttpParameters

SetQueryStringParameters sets the QueryStringParameters field's value.

func (ConnectionHttpParameters) String added in v1.37.24 

func (s ConnectionHttpParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionOAuthClientResponseParameters added in v1.37.24 

type ConnectionOAuthClientResponseParameters struct {

	// The client ID associated with the response to the connection request.
	ClientID *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the client response parameters for the connection when OAuth is specified as the authorization type.

func (ConnectionOAuthClientResponseParameters) GoString added in v1.37.24 

func (s ConnectionOAuthClientResponseParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionOAuthClientResponseParameters) SetClientID added in v1.37.24 

func (s *ConnectionOAuthClientResponseParameters) SetClientID(v string) *ConnectionOAuthClientResponseParameters

SetClientID sets the ClientID field's value.

func (ConnectionOAuthClientResponseParameters) String added in v1.37.24 

func (s ConnectionOAuthClientResponseParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionOAuthResponseParameters added in v1.37.24 

type ConnectionOAuthResponseParameters struct {

	// The URL to the HTTP endpoint that authorized the request.
	AuthorizationEndpoint *string `min:"1" type:"string"`

	// A ConnectionOAuthClientResponseParameters object that contains details about
	// the client parameters returned when OAuth is specified as the authorization
	// type.
	ClientParameters *ConnectionOAuthClientResponseParameters `type:"structure"`

	// The method used to connect to the HTTP endpoint.
	HttpMethod *string `type:"string" enum:"ConnectionOAuthHttpMethod"`

	// The additional HTTP parameters used for the OAuth authorization request.
	OAuthHttpParameters *ConnectionHttpParameters `type:"structure"`
	// contains filtered or unexported fields
}

Contains the response parameters when OAuth is specified as the authorization type.

func (ConnectionOAuthResponseParameters) GoString added in v1.37.24 

func (s ConnectionOAuthResponseParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionOAuthResponseParameters) SetAuthorizationEndpoint added in v1.37.24 

func (s *ConnectionOAuthResponseParameters) SetAuthorizationEndpoint(v string) *ConnectionOAuthResponseParameters

SetAuthorizationEndpoint sets the AuthorizationEndpoint field's value.

func (*ConnectionOAuthResponseParameters) SetClientParameters added in v1.37.24 

func (s *ConnectionOAuthResponseParameters) SetClientParameters(v *ConnectionOAuthClientResponseParameters) *ConnectionOAuthResponseParameters

SetClientParameters sets the ClientParameters field's value.

func (*ConnectionOAuthResponseParameters) SetHttpMethod added in v1.37.24 

func (s *ConnectionOAuthResponseParameters) SetHttpMethod(v string) *ConnectionOAuthResponseParameters

SetHttpMethod sets the HttpMethod field's value.

func (*ConnectionOAuthResponseParameters) SetOAuthHttpParameters added in v1.37.24 

func (s *ConnectionOAuthResponseParameters) SetOAuthHttpParameters(v *ConnectionHttpParameters) *ConnectionOAuthResponseParameters

SetOAuthHttpParameters sets the OAuthHttpParameters field's value.

func (ConnectionOAuthResponseParameters) String added in v1.37.24 

func (s ConnectionOAuthResponseParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionQueryStringParameter added in v1.37.24 

type ConnectionQueryStringParameter struct {

	// Specifies whether the value is secret.
	IsValueSecret *bool `type:"boolean"`

	// The key for a query string parameter.
	Key *string `type:"string"`

	// The value associated with the key for the query string parameter.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ConnectionQueryStringParameter's
	// String and GoString methods.
	Value *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

func (ConnectionQueryStringParameter) GoString added in v1.37.24 

func (s ConnectionQueryStringParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionQueryStringParameter) SetIsValueSecret added in v1.37.24 

func (s *ConnectionQueryStringParameter) SetIsValueSecret(v bool) *ConnectionQueryStringParameter

SetIsValueSecret sets the IsValueSecret field's value.

func (*ConnectionQueryStringParameter) SetKey added in v1.37.24 

func (s *ConnectionQueryStringParameter) SetKey(v string) *ConnectionQueryStringParameter

SetKey sets the Key field's value.

func (*ConnectionQueryStringParameter) SetValue added in v1.37.24 

func (s *ConnectionQueryStringParameter) SetValue(v string) *ConnectionQueryStringParameter

SetValue sets the Value field's value.

func (ConnectionQueryStringParameter) String added in v1.37.24 

func (s ConnectionQueryStringParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateApiDestinationInput added in v1.37.24 

type CreateApiDestinationInput struct {

	// The ARN of the connection to use for the API destination. The destination
	// endpoint must support the authorization type specified for the connection.
	//
	// ConnectionArn is a required field
	ConnectionArn *string `min:"1" type:"string" required:"true"`

	// A description for the API destination to create.
	Description *string `type:"string"`

	// The method to use for the request to the HTTP invocation endpoint.
	//
	// HttpMethod is a required field
	HttpMethod *string `type:"string" required:"true" enum:"ApiDestinationHttpMethod"`

	// The URL to the HTTP invocation endpoint for the API destination.
	//
	// InvocationEndpoint is a required field
	InvocationEndpoint *string `min:"1" type:"string" required:"true"`

	// The maximum number of requests per second to send to the HTTP invocation
	// endpoint.
	InvocationRateLimitPerSecond *int64 `min:"1" type:"integer"`

	// The name for the API destination to create.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateApiDestinationInput) GoString added in v1.37.24 

func (s CreateApiDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateApiDestinationInput) SetConnectionArn added in v1.37.24 

func (s *CreateApiDestinationInput) SetConnectionArn(v string) *CreateApiDestinationInput

SetConnectionArn sets the ConnectionArn field's value.

func (*CreateApiDestinationInput) SetDescription added in v1.37.24 

func (s *CreateApiDestinationInput) SetDescription(v string) *CreateApiDestinationInput

SetDescription sets the Description field's value.

func (*CreateApiDestinationInput) SetHttpMethod added in v1.37.24 

func (s *CreateApiDestinationInput) SetHttpMethod(v string) *CreateApiDestinationInput

SetHttpMethod sets the HttpMethod field's value.

func (*CreateApiDestinationInput) SetInvocationEndpoint added in v1.37.24 

func (s *CreateApiDestinationInput) SetInvocationEndpoint(v string) *CreateApiDestinationInput

SetInvocationEndpoint sets the InvocationEndpoint field's value.

func (*CreateApiDestinationInput) SetInvocationRateLimitPerSecond added in v1.37.24 

func (s *CreateApiDestinationInput) SetInvocationRateLimitPerSecond(v int64) *CreateApiDestinationInput

SetInvocationRateLimitPerSecond sets the InvocationRateLimitPerSecond field's value.

func (*CreateApiDestinationInput) SetName added in v1.37.24 

func (s *CreateApiDestinationInput) SetName(v string) *CreateApiDestinationInput

SetName sets the Name field's value.

func (CreateApiDestinationInput) String added in v1.37.24 

func (s CreateApiDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateApiDestinationInput) Validate added in v1.37.24 

func (s *CreateApiDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateApiDestinationOutput added in v1.37.24 

type CreateApiDestinationOutput struct {

	// The ARN of the API destination that was created by the request.
	ApiDestinationArn *string `min:"1" type:"string"`

	// The state of the API destination that was created by the request.
	ApiDestinationState *string `type:"string" enum:"ApiDestinationState"`

	// A time stamp indicating the time that the API destination was created.
	CreationTime *time.Time `type:"timestamp"`

	// A time stamp indicating the time that the API destination was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (CreateApiDestinationOutput) GoString added in v1.37.24 

func (s CreateApiDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateApiDestinationOutput) SetApiDestinationArn added in v1.37.24 

func (s *CreateApiDestinationOutput) SetApiDestinationArn(v string) *CreateApiDestinationOutput

SetApiDestinationArn sets the ApiDestinationArn field's value.

func (*CreateApiDestinationOutput) SetApiDestinationState added in v1.37.24 

func (s *CreateApiDestinationOutput) SetApiDestinationState(v string) *CreateApiDestinationOutput

SetApiDestinationState sets the ApiDestinationState field's value.

func (*CreateApiDestinationOutput) SetCreationTime added in v1.37.24 

func (s *CreateApiDestinationOutput) SetCreationTime(v time.Time) *CreateApiDestinationOutput

SetCreationTime sets the CreationTime field's value.

func (*CreateApiDestinationOutput) SetLastModifiedTime added in v1.37.24 

func (s *CreateApiDestinationOutput) SetLastModifiedTime(v time.Time) *CreateApiDestinationOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (CreateApiDestinationOutput) String added in v1.37.24 

func (s CreateApiDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateArchiveInput added in v1.35.22 

type CreateArchiveInput struct {

	// The name for the archive to create.
	//
	// ArchiveName is a required field
	ArchiveName *string `min:"1" type:"string" required:"true"`

	// A description for the archive.
	Description *string `type:"string"`

	// An event pattern to use to filter events sent to the archive.
	EventPattern *string `type:"string"`

	// The ARN of the event bus that sends events to the archive.
	//
	// EventSourceArn is a required field
	EventSourceArn *string `min:"1" type:"string" required:"true"`

	// The number of days to retain events for. Default value is 0. If set to 0,
	// events are retained indefinitely
	RetentionDays *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (CreateArchiveInput) GoString added in v1.35.22 

func (s CreateArchiveInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateArchiveInput) SetArchiveName added in v1.35.22 

func (s *CreateArchiveInput) SetArchiveName(v string) *CreateArchiveInput

SetArchiveName sets the ArchiveName field's value.

func (*CreateArchiveInput) SetDescription added in v1.35.22 

func (s *CreateArchiveInput) SetDescription(v string) *CreateArchiveInput

SetDescription sets the Description field's value.

func (*CreateArchiveInput) SetEventPattern added in v1.35.22 

func (s *CreateArchiveInput) SetEventPattern(v string) *CreateArchiveInput

SetEventPattern sets the EventPattern field's value.

func (*CreateArchiveInput) SetEventSourceArn added in v1.35.22 

func (s *CreateArchiveInput) SetEventSourceArn(v string) *CreateArchiveInput

SetEventSourceArn sets the EventSourceArn field's value.

func (*CreateArchiveInput) SetRetentionDays added in v1.35.22 

func (s *CreateArchiveInput) SetRetentionDays(v int64) *CreateArchiveInput

SetRetentionDays sets the RetentionDays field's value.

func (CreateArchiveInput) String added in v1.35.22 

func (s CreateArchiveInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateArchiveInput) Validate added in v1.35.22 

func (s *CreateArchiveInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateArchiveOutput added in v1.35.22 

type CreateArchiveOutput struct {

	// The ARN of the archive that was created.
	ArchiveArn *string `min:"1" type:"string"`

	// The time at which the archive was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state of the archive that was created.
	State *string `type:"string" enum:"ArchiveState"`

	// The reason that the archive is in the state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateArchiveOutput) GoString added in v1.35.22 

func (s CreateArchiveOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateArchiveOutput) SetArchiveArn added in v1.35.22 

func (s *CreateArchiveOutput) SetArchiveArn(v string) *CreateArchiveOutput

SetArchiveArn sets the ArchiveArn field's value.

func (*CreateArchiveOutput) SetCreationTime added in v1.35.22 

func (s *CreateArchiveOutput) SetCreationTime(v time.Time) *CreateArchiveOutput

SetCreationTime sets the CreationTime field's value.

func (*CreateArchiveOutput) SetState added in v1.35.22 

func (s *CreateArchiveOutput) SetState(v string) *CreateArchiveOutput

SetState sets the State field's value.

func (*CreateArchiveOutput) SetStateReason added in v1.35.22 

func (s *CreateArchiveOutput) SetStateReason(v string) *CreateArchiveOutput

SetStateReason sets the StateReason field's value.

func (CreateArchiveOutput) String added in v1.35.22 

func (s CreateArchiveOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateConnectionApiKeyAuthRequestParameters added in v1.37.24 

type CreateConnectionApiKeyAuthRequestParameters struct {

	// The name of the API key to use for authorization.
	//
	// ApiKeyName is a required field
	ApiKeyName *string `min:"1" type:"string" required:"true"`

	// The value for the API key to use for authorization.
	//
	// ApiKeyValue is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateConnectionApiKeyAuthRequestParameters's
	// String and GoString methods.
	//
	// ApiKeyValue is a required field
	ApiKeyValue *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the API key authorization parameters for the connection.

func (CreateConnectionApiKeyAuthRequestParameters) GoString added in v1.37.24 

func (s CreateConnectionApiKeyAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionApiKeyAuthRequestParameters) SetApiKeyName added in v1.37.24 

func (s *CreateConnectionApiKeyAuthRequestParameters) SetApiKeyName(v string) *CreateConnectionApiKeyAuthRequestParameters

SetApiKeyName sets the ApiKeyName field's value.

func (*CreateConnectionApiKeyAuthRequestParameters) SetApiKeyValue added in v1.37.24 

func (s *CreateConnectionApiKeyAuthRequestParameters) SetApiKeyValue(v string) *CreateConnectionApiKeyAuthRequestParameters

SetApiKeyValue sets the ApiKeyValue field's value.

func (CreateConnectionApiKeyAuthRequestParameters) String added in v1.37.24 

func (s CreateConnectionApiKeyAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionApiKeyAuthRequestParameters) Validate added in v1.37.24 

func (s *CreateConnectionApiKeyAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectionAuthRequestParameters added in v1.37.24 

type CreateConnectionAuthRequestParameters struct {

	// A CreateConnectionApiKeyAuthRequestParameters object that contains the API
	// key authorization parameters to use for the connection.
	ApiKeyAuthParameters *CreateConnectionApiKeyAuthRequestParameters `type:"structure"`

	// A CreateConnectionBasicAuthRequestParameters object that contains the Basic
	// authorization parameters to use for the connection.
	BasicAuthParameters *CreateConnectionBasicAuthRequestParameters `type:"structure"`

	// A ConnectionHttpParameters object that contains the API key authorization
	// parameters to use for the connection. Note that if you include additional
	// parameters for the target of a rule via HttpParameters, including query strings,
	// the parameters added for the connection take precedence.
	InvocationHttpParameters *ConnectionHttpParameters `type:"structure"`

	// A CreateConnectionOAuthRequestParameters object that contains the OAuth authorization
	// parameters to use for the connection.
	OAuthParameters *CreateConnectionOAuthRequestParameters `type:"structure"`
	// contains filtered or unexported fields
}

Contains the authorization parameters for the connection.

func (CreateConnectionAuthRequestParameters) GoString added in v1.37.24 

func (s CreateConnectionAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionAuthRequestParameters) SetApiKeyAuthParameters added in v1.37.24 

func (s *CreateConnectionAuthRequestParameters) SetApiKeyAuthParameters(v *CreateConnectionApiKeyAuthRequestParameters) *CreateConnectionAuthRequestParameters

SetApiKeyAuthParameters sets the ApiKeyAuthParameters field's value.

func (*CreateConnectionAuthRequestParameters) SetBasicAuthParameters added in v1.37.24 

func (s *CreateConnectionAuthRequestParameters) SetBasicAuthParameters(v *CreateConnectionBasicAuthRequestParameters) *CreateConnectionAuthRequestParameters

SetBasicAuthParameters sets the BasicAuthParameters field's value.

func (*CreateConnectionAuthRequestParameters) SetInvocationHttpParameters added in v1.37.24 

func (s *CreateConnectionAuthRequestParameters) SetInvocationHttpParameters(v *ConnectionHttpParameters) *CreateConnectionAuthRequestParameters

SetInvocationHttpParameters sets the InvocationHttpParameters field's value.

func (*CreateConnectionAuthRequestParameters) SetOAuthParameters added in v1.37.24 

func (s *CreateConnectionAuthRequestParameters) SetOAuthParameters(v *CreateConnectionOAuthRequestParameters) *CreateConnectionAuthRequestParameters

SetOAuthParameters sets the OAuthParameters field's value.

func (CreateConnectionAuthRequestParameters) String added in v1.37.24 

func (s CreateConnectionAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionAuthRequestParameters) Validate added in v1.37.24 

func (s *CreateConnectionAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectionBasicAuthRequestParameters added in v1.37.24 

type CreateConnectionBasicAuthRequestParameters struct {

	// The password associated with the user name to use for Basic authorization.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateConnectionBasicAuthRequestParameters's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The user name to use for Basic authorization.
	//
	// Username is a required field
	Username *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the Basic authorization parameters to use for the connection.

func (CreateConnectionBasicAuthRequestParameters) GoString added in v1.37.24 

func (s CreateConnectionBasicAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionBasicAuthRequestParameters) SetPassword added in v1.37.24 

func (s *CreateConnectionBasicAuthRequestParameters) SetPassword(v string) *CreateConnectionBasicAuthRequestParameters

SetPassword sets the Password field's value.

func (*CreateConnectionBasicAuthRequestParameters) SetUsername added in v1.37.24 

func (s *CreateConnectionBasicAuthRequestParameters) SetUsername(v string) *CreateConnectionBasicAuthRequestParameters

SetUsername sets the Username field's value.

func (CreateConnectionBasicAuthRequestParameters) String added in v1.37.24 

func (s CreateConnectionBasicAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionBasicAuthRequestParameters) Validate added in v1.37.24 

func (s *CreateConnectionBasicAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectionInput added in v1.37.24 

type CreateConnectionInput struct {

	// A CreateConnectionAuthRequestParameters object that contains the authorization
	// parameters to use to authorize with the endpoint.
	//
	// AuthParameters is a required field
	AuthParameters *CreateConnectionAuthRequestParameters `type:"structure" required:"true"`

	// The type of authorization to use for the connection.
	//
	// AuthorizationType is a required field
	AuthorizationType *string `type:"string" required:"true" enum:"ConnectionAuthorizationType"`

	// A description for the connection to create.
	Description *string `type:"string"`

	// The name for the connection to create.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateConnectionInput) GoString added in v1.37.24 

func (s CreateConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionInput) SetAuthParameters added in v1.37.24 

func (s *CreateConnectionInput) SetAuthParameters(v *CreateConnectionAuthRequestParameters) *CreateConnectionInput

SetAuthParameters sets the AuthParameters field's value.

func (*CreateConnectionInput) SetAuthorizationType added in v1.37.24 

func (s *CreateConnectionInput) SetAuthorizationType(v string) *CreateConnectionInput

SetAuthorizationType sets the AuthorizationType field's value.

func (*CreateConnectionInput) SetDescription added in v1.37.24 

func (s *CreateConnectionInput) SetDescription(v string) *CreateConnectionInput

SetDescription sets the Description field's value.

func (*CreateConnectionInput) SetName added in v1.37.24 

func (s *CreateConnectionInput) SetName(v string) *CreateConnectionInput

SetName sets the Name field's value.

func (CreateConnectionInput) String added in v1.37.24 

func (s CreateConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionInput) Validate added in v1.37.24 

func (s *CreateConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectionOAuthClientRequestParameters added in v1.37.24 

type CreateConnectionOAuthClientRequestParameters struct {

	// The client ID to use for OAuth authorization for the connection.
	//
	// ClientID is a required field
	ClientID *string `min:"1" type:"string" required:"true"`

	// The client secret associated with the client ID to use for OAuth authorization
	// for the connection.
	//
	// ClientSecret is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateConnectionOAuthClientRequestParameters's
	// String and GoString methods.
	//
	// ClientSecret is a required field
	ClientSecret *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the Basic authorization parameters to use for the connection.

func (CreateConnectionOAuthClientRequestParameters) GoString added in v1.37.24 

func (s CreateConnectionOAuthClientRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionOAuthClientRequestParameters) SetClientID added in v1.37.24 

func (s *CreateConnectionOAuthClientRequestParameters) SetClientID(v string) *CreateConnectionOAuthClientRequestParameters

SetClientID sets the ClientID field's value.

func (*CreateConnectionOAuthClientRequestParameters) SetClientSecret added in v1.37.24 

func (s *CreateConnectionOAuthClientRequestParameters) SetClientSecret(v string) *CreateConnectionOAuthClientRequestParameters

SetClientSecret sets the ClientSecret field's value.

func (CreateConnectionOAuthClientRequestParameters) String added in v1.37.24 

func (s CreateConnectionOAuthClientRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionOAuthClientRequestParameters) Validate added in v1.37.24 

func (s *CreateConnectionOAuthClientRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectionOAuthRequestParameters added in v1.37.24 

type CreateConnectionOAuthRequestParameters struct {

	// The URL to the authorization endpoint when OAuth is specified as the authorization
	// type.
	//
	// AuthorizationEndpoint is a required field
	AuthorizationEndpoint *string `min:"1" type:"string" required:"true"`

	// A CreateConnectionOAuthClientRequestParameters object that contains the client
	// parameters for OAuth authorization.
	//
	// ClientParameters is a required field
	ClientParameters *CreateConnectionOAuthClientRequestParameters `type:"structure" required:"true"`

	// The method to use for the authorization request.
	//
	// HttpMethod is a required field
	HttpMethod *string `type:"string" required:"true" enum:"ConnectionOAuthHttpMethod"`

	// A ConnectionHttpParameters object that contains details about the additional
	// parameters to use for the connection.
	OAuthHttpParameters *ConnectionHttpParameters `type:"structure"`
	// contains filtered or unexported fields
}

Contains the OAuth authorization parameters to use for the connection.

func (CreateConnectionOAuthRequestParameters) GoString added in v1.37.24 

func (s CreateConnectionOAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionOAuthRequestParameters) SetAuthorizationEndpoint added in v1.37.24 

func (s *CreateConnectionOAuthRequestParameters) SetAuthorizationEndpoint(v string) *CreateConnectionOAuthRequestParameters

SetAuthorizationEndpoint sets the AuthorizationEndpoint field's value.

func (*CreateConnectionOAuthRequestParameters) SetClientParameters added in v1.37.24 

func (s *CreateConnectionOAuthRequestParameters) SetClientParameters(v *CreateConnectionOAuthClientRequestParameters) *CreateConnectionOAuthRequestParameters

SetClientParameters sets the ClientParameters field's value.

func (*CreateConnectionOAuthRequestParameters) SetHttpMethod added in v1.37.24 

func (s *CreateConnectionOAuthRequestParameters) SetHttpMethod(v string) *CreateConnectionOAuthRequestParameters

SetHttpMethod sets the HttpMethod field's value.

func (*CreateConnectionOAuthRequestParameters) SetOAuthHttpParameters added in v1.37.24 

func (s *CreateConnectionOAuthRequestParameters) SetOAuthHttpParameters(v *ConnectionHttpParameters) *CreateConnectionOAuthRequestParameters

SetOAuthHttpParameters sets the OAuthHttpParameters field's value.

func (CreateConnectionOAuthRequestParameters) String added in v1.37.24 

func (s CreateConnectionOAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionOAuthRequestParameters) Validate added in v1.37.24 

func (s *CreateConnectionOAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateConnectionOutput added in v1.37.24 

type CreateConnectionOutput struct {

	// The ARN of the connection that was created by the request.
	ConnectionArn *string `min:"1" type:"string"`

	// The state of the connection that was created by the request.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// A time stamp for the time that the connection was created.
	CreationTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last updated.
	LastModifiedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (CreateConnectionOutput) GoString added in v1.37.24 

func (s CreateConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionOutput) SetConnectionArn added in v1.37.24 

func (s *CreateConnectionOutput) SetConnectionArn(v string) *CreateConnectionOutput

SetConnectionArn sets the ConnectionArn field's value.

func (*CreateConnectionOutput) SetConnectionState added in v1.37.24 

func (s *CreateConnectionOutput) SetConnectionState(v string) *CreateConnectionOutput

SetConnectionState sets the ConnectionState field's value.

func (*CreateConnectionOutput) SetCreationTime added in v1.37.24 

func (s *CreateConnectionOutput) SetCreationTime(v time.Time) *CreateConnectionOutput

SetCreationTime sets the CreationTime field's value.

func (*CreateConnectionOutput) SetLastModifiedTime added in v1.37.24 

func (s *CreateConnectionOutput) SetLastModifiedTime(v time.Time) *CreateConnectionOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (CreateConnectionOutput) String added in v1.37.24 

func (s CreateConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateEventBusInput added in v1.20.19 

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) GoString added in v1.20.19 

func (s CreateEventBusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEventBusInput) SetEventSourceName added in v1.20.19 

func (s *CreateEventBusInput) SetEventSourceName(v string) *CreateEventBusInput

SetEventSourceName sets the EventSourceName field's value.

func (*CreateEventBusInput) SetName added in v1.20.19 

func (s *CreateEventBusInput) SetName(v string) *CreateEventBusInput

SetName sets the Name field's value.

func (*CreateEventBusInput) SetTags added in v1.29.9 

func (s *CreateEventBusInput) SetTags(v []*Tag) *CreateEventBusInput

SetTags sets the Tags field's value.

func (CreateEventBusInput) String added in v1.20.19 

func (s CreateEventBusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEventBusInput) Validate added in v1.20.19 

func (s *CreateEventBusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEventBusOutput added in v1.20.19 

type CreateEventBusOutput struct {

	// The ARN of the new event bus.
	EventBusArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateEventBusOutput) GoString added in v1.20.19 

func (s CreateEventBusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateEventBusOutput) SetEventBusArn added in v1.20.19 

func (s *CreateEventBusOutput) SetEventBusArn(v string) *CreateEventBusOutput

SetEventBusArn sets the EventBusArn field's value.

func (CreateEventBusOutput) String added in v1.20.19 

func (s CreateEventBusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePartnerEventSourceInput added in v1.20.19 

type CreatePartnerEventSourceInput struct {

	// The Amazon Web Services 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 Amazon Web Services
	// account that wants to use this partner event source must create a partner
	// event bus with a name that matches the name of the partner event source.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePartnerEventSourceInput) GoString added in v1.20.19 

func (s CreatePartnerEventSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePartnerEventSourceInput) SetAccount added in v1.20.19 

func (s *CreatePartnerEventSourceInput) SetAccount(v string) *CreatePartnerEventSourceInput

SetAccount sets the Account field's value.

func (*CreatePartnerEventSourceInput) SetName added in v1.20.19 

func (s *CreatePartnerEventSourceInput) SetName(v string) *CreatePartnerEventSourceInput

SetName sets the Name field's value.

func (CreatePartnerEventSourceInput) String added in v1.20.19 

func (s CreatePartnerEventSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePartnerEventSourceInput) Validate added in v1.20.19 

func (s *CreatePartnerEventSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePartnerEventSourceOutput added in v1.20.19 

type CreatePartnerEventSourceOutput struct {

	// The ARN of the partner event source.
	EventSourceArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreatePartnerEventSourceOutput) GoString added in v1.20.19 

func (s CreatePartnerEventSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePartnerEventSourceOutput) SetEventSourceArn added in v1.20.19 

func (s *CreatePartnerEventSourceOutput) SetEventSourceArn(v string) *CreatePartnerEventSourceOutput

SetEventSourceArn sets the EventSourceArn field's value.

func (CreatePartnerEventSourceOutput) String added in v1.20.19 

func (s CreatePartnerEventSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeactivateEventSourceInput added in v1.20.19 

type DeactivateEventSourceInput struct {

	// The name of the partner event source to deactivate.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeactivateEventSourceInput) GoString added in v1.20.19 

func (s DeactivateEventSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateEventSourceInput) SetName added in v1.20.19 

func (s *DeactivateEventSourceInput) SetName(v string) *DeactivateEventSourceInput

SetName sets the Name field's value.

func (DeactivateEventSourceInput) String added in v1.20.19 

func (s DeactivateEventSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeactivateEventSourceInput) Validate added in v1.20.19 

func (s *DeactivateEventSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeactivateEventSourceOutput added in v1.20.19 

type DeactivateEventSourceOutput struct {
	// contains filtered or unexported fields
}

func (DeactivateEventSourceOutput) GoString added in v1.20.19 

func (s DeactivateEventSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeactivateEventSourceOutput) String added in v1.20.19 

func (s DeactivateEventSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeadLetterConfig added in v1.35.6 

type DeadLetterConfig struct {

	// The ARN of the SQS queue specified as the target for the dead-letter queue.
	Arn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

func (DeadLetterConfig) GoString added in v1.35.6 

func (s DeadLetterConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeadLetterConfig) SetArn added in v1.35.6 

func (s *DeadLetterConfig) SetArn(v string) *DeadLetterConfig

SetArn sets the Arn field's value.

func (DeadLetterConfig) String added in v1.35.6 

func (s DeadLetterConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeadLetterConfig) Validate added in v1.35.6 

func (s *DeadLetterConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeauthorizeConnectionInput added in v1.37.24 

type DeauthorizeConnectionInput struct {

	// The name of the connection to remove authorization from.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeauthorizeConnectionInput) GoString added in v1.37.24 

func (s DeauthorizeConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeauthorizeConnectionInput) SetName added in v1.37.24 

func (s *DeauthorizeConnectionInput) SetName(v string) *DeauthorizeConnectionInput

SetName sets the Name field's value.

func (DeauthorizeConnectionInput) String added in v1.37.24 

func (s DeauthorizeConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeauthorizeConnectionInput) Validate added in v1.37.24 

func (s *DeauthorizeConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeauthorizeConnectionOutput added in v1.37.24 

type DeauthorizeConnectionOutput struct {

	// The ARN of the connection that authorization was removed from.
	ConnectionArn *string `min:"1" type:"string"`

	// The state of the connection.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// A time stamp for the time that the connection was created.
	CreationTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last authorized.
	LastAuthorizedTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last updated.
	LastModifiedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DeauthorizeConnectionOutput) GoString added in v1.37.24 

func (s DeauthorizeConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeauthorizeConnectionOutput) SetConnectionArn added in v1.37.24 

func (s *DeauthorizeConnectionOutput) SetConnectionArn(v string) *DeauthorizeConnectionOutput

SetConnectionArn sets the ConnectionArn field's value.

func (*DeauthorizeConnectionOutput) SetConnectionState added in v1.37.24 

func (s *DeauthorizeConnectionOutput) SetConnectionState(v string) *DeauthorizeConnectionOutput

SetConnectionState sets the ConnectionState field's value.

func (*DeauthorizeConnectionOutput) SetCreationTime added in v1.37.24 

func (s *DeauthorizeConnectionOutput) SetCreationTime(v time.Time) *DeauthorizeConnectionOutput

SetCreationTime sets the CreationTime field's value.

func (*DeauthorizeConnectionOutput) SetLastAuthorizedTime added in v1.37.24 

func (s *DeauthorizeConnectionOutput) SetLastAuthorizedTime(v time.Time) *DeauthorizeConnectionOutput

SetLastAuthorizedTime sets the LastAuthorizedTime field's value.

func (*DeauthorizeConnectionOutput) SetLastModifiedTime added in v1.37.24 

func (s *DeauthorizeConnectionOutput) SetLastModifiedTime(v time.Time) *DeauthorizeConnectionOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (DeauthorizeConnectionOutput) String added in v1.37.24 

func (s DeauthorizeConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteApiDestinationInput added in v1.37.24 

type DeleteApiDestinationInput struct {

	// The name of the destination to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteApiDestinationInput) GoString added in v1.37.24 

func (s DeleteApiDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApiDestinationInput) SetName added in v1.37.24 

func (s *DeleteApiDestinationInput) SetName(v string) *DeleteApiDestinationInput

SetName sets the Name field's value.

func (DeleteApiDestinationInput) String added in v1.37.24 

func (s DeleteApiDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteApiDestinationInput) Validate added in v1.37.24 

func (s *DeleteApiDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteApiDestinationOutput added in v1.37.24 

type DeleteApiDestinationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteApiDestinationOutput) GoString added in v1.37.24 

func (s DeleteApiDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteApiDestinationOutput) String added in v1.37.24 

func (s DeleteApiDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteArchiveInput added in v1.35.22 

type DeleteArchiveInput struct {

	// The name of the archive to delete.
	//
	// ArchiveName is a required field
	ArchiveName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteArchiveInput) GoString added in v1.35.22 

func (s DeleteArchiveInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteArchiveInput) SetArchiveName added in v1.35.22 

func (s *DeleteArchiveInput) SetArchiveName(v string) *DeleteArchiveInput

SetArchiveName sets the ArchiveName field's value.

func (DeleteArchiveInput) String added in v1.35.22 

func (s DeleteArchiveInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteArchiveInput) Validate added in v1.35.22 

func (s *DeleteArchiveInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteArchiveOutput added in v1.35.22 

type DeleteArchiveOutput struct {
	// contains filtered or unexported fields
}

func (DeleteArchiveOutput) GoString added in v1.35.22 

func (s DeleteArchiveOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteArchiveOutput) String added in v1.35.22 

func (s DeleteArchiveOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteConnectionInput added in v1.37.24 

type DeleteConnectionInput struct {

	// The name of the connection to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConnectionInput) GoString added in v1.37.24 

func (s DeleteConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectionInput) SetName added in v1.37.24 

func (s *DeleteConnectionInput) SetName(v string) *DeleteConnectionInput

SetName sets the Name field's value.

func (DeleteConnectionInput) String added in v1.37.24 

func (s DeleteConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectionInput) Validate added in v1.37.24 

func (s *DeleteConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteConnectionOutput added in v1.37.24 

type DeleteConnectionOutput struct {

	// The ARN of the connection that was deleted.
	ConnectionArn *string `min:"1" type:"string"`

	// The state of the connection before it was deleted.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// A time stamp for the time that the connection was created.
	CreationTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last authorized before
	// it wa deleted.
	LastAuthorizedTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last modified before it
	// was deleted.
	LastModifiedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DeleteConnectionOutput) GoString added in v1.37.24 

func (s DeleteConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectionOutput) SetConnectionArn added in v1.37.24 

func (s *DeleteConnectionOutput) SetConnectionArn(v string) *DeleteConnectionOutput

SetConnectionArn sets the ConnectionArn field's value.

func (*DeleteConnectionOutput) SetConnectionState added in v1.37.24 

func (s *DeleteConnectionOutput) SetConnectionState(v string) *DeleteConnectionOutput

SetConnectionState sets the ConnectionState field's value.

func (*DeleteConnectionOutput) SetCreationTime added in v1.37.24 

func (s *DeleteConnectionOutput) SetCreationTime(v time.Time) *DeleteConnectionOutput

SetCreationTime sets the CreationTime field's value.

func (*DeleteConnectionOutput) SetLastAuthorizedTime added in v1.37.24 

func (s *DeleteConnectionOutput) SetLastAuthorizedTime(v time.Time) *DeleteConnectionOutput

SetLastAuthorizedTime sets the LastAuthorizedTime field's value.

func (*DeleteConnectionOutput) SetLastModifiedTime added in v1.37.24 

func (s *DeleteConnectionOutput) SetLastModifiedTime(v time.Time) *DeleteConnectionOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (DeleteConnectionOutput) String added in v1.37.24 

func (s DeleteConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteEventBusInput added in v1.20.19 

type DeleteEventBusInput struct {

	// The name of the event bus to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEventBusInput) GoString added in v1.20.19 

func (s DeleteEventBusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEventBusInput) SetName added in v1.20.19 

func (s *DeleteEventBusInput) SetName(v string) *DeleteEventBusInput

SetName sets the Name field's value.

func (DeleteEventBusInput) String added in v1.20.19 

func (s DeleteEventBusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteEventBusInput) Validate added in v1.20.19 

func (s *DeleteEventBusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEventBusOutput added in v1.20.19 

type DeleteEventBusOutput struct {
	// contains filtered or unexported fields
}

func (DeleteEventBusOutput) GoString added in v1.20.19 

func (s DeleteEventBusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteEventBusOutput) String added in v1.20.19 

func (s DeleteEventBusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePartnerEventSourceInput added in v1.20.19 

type DeletePartnerEventSourceInput struct {

	// The Amazon Web Services account ID of the Amazon Web Services customer that
	// the event source was created for.
	//
	// Account is a required field
	Account *string `min:"12" type:"string" required:"true"`

	// The name of the event source to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePartnerEventSourceInput) GoString added in v1.20.19 

func (s DeletePartnerEventSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePartnerEventSourceInput) SetAccount added in v1.20.19 

func (s *DeletePartnerEventSourceInput) SetAccount(v string) *DeletePartnerEventSourceInput

SetAccount sets the Account field's value.

func (*DeletePartnerEventSourceInput) SetName added in v1.20.19 

func (s *DeletePartnerEventSourceInput) SetName(v string) *DeletePartnerEventSourceInput

SetName sets the Name field's value.

func (DeletePartnerEventSourceInput) String added in v1.20.19 

func (s DeletePartnerEventSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePartnerEventSourceInput) Validate added in v1.20.19 

func (s *DeletePartnerEventSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeletePartnerEventSourceOutput added in v1.20.19 

type DeletePartnerEventSourceOutput struct {
	// contains filtered or unexported fields
}

func (DeletePartnerEventSourceOutput) GoString added in v1.20.19 

func (s DeletePartnerEventSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeletePartnerEventSourceOutput) String added in v1.20.19 

func (s DeletePartnerEventSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRuleInput 

type DeleteRuleInput struct {

	// The name or ARN of 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 Amazon Web Services service on your
	// behalf, you must specify Force as True to delete the rule. This parameter
	// is ignored for rules that are not managed rules. You can check whether a
	// rule is a managed rule by using DescribeRule or ListRules and checking the
	// ManagedBy field of the response.
	Force *bool `type:"boolean"`

	// The name of the rule.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRuleInput) GoString 

func (s DeleteRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleInput) SetEventBusName added in v1.20.19 

func (s *DeleteRuleInput) SetEventBusName(v string) *DeleteRuleInput

SetEventBusName sets the EventBusName field's value.

func (*DeleteRuleInput) SetForce added in v1.15.87 

func (s *DeleteRuleInput) SetForce(v bool) *DeleteRuleInput

SetForce sets the Force field's value.

func (*DeleteRuleInput) SetName added in v1.5.0 

func (s *DeleteRuleInput) SetName(v string) *DeleteRuleInput

SetName sets the Name field's value.

func (DeleteRuleInput) String 

func (s DeleteRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleInput) Validate added in v1.1.21 

func (s *DeleteRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRuleOutput 

type DeleteRuleOutput struct {
	// contains filtered or unexported fields
}

func (DeleteRuleOutput) GoString 

func (s DeleteRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRuleOutput) String 

func (s DeleteRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeApiDestinationInput added in v1.37.24 

type DescribeApiDestinationInput struct {

	// The name of the API destination to retrieve.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeApiDestinationInput) GoString added in v1.37.24 

func (s DescribeApiDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApiDestinationInput) SetName added in v1.37.24 

func (s *DescribeApiDestinationInput) SetName(v string) *DescribeApiDestinationInput

SetName sets the Name field's value.

func (DescribeApiDestinationInput) String added in v1.37.24 

func (s DescribeApiDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApiDestinationInput) Validate added in v1.37.24 

func (s *DescribeApiDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeApiDestinationOutput added in v1.37.24 

type DescribeApiDestinationOutput struct {

	// The ARN of the API destination retrieved.
	ApiDestinationArn *string `min:"1" type:"string"`

	// The state of the API destination retrieved.
	ApiDestinationState *string `type:"string" enum:"ApiDestinationState"`

	// The ARN of the connection specified for the API destination retrieved.
	ConnectionArn *string `min:"1" type:"string"`

	// A time stamp for the time that the API destination was created.
	CreationTime *time.Time `type:"timestamp"`

	// The description for the API destination retrieved.
	Description *string `type:"string"`

	// The method to use to connect to the HTTP endpoint.
	HttpMethod *string `type:"string" enum:"ApiDestinationHttpMethod"`

	// The URL to use to connect to the HTTP endpoint.
	InvocationEndpoint *string `min:"1" type:"string"`

	// The maximum number of invocations per second to specified for the API destination.
	// Note that if you set the invocation rate maximum to a value lower the rate
	// necessary to send all events received on to the destination HTTP endpoint,
	// some events may not be delivered within the 24-hour retry window. If you
	// plan to set the rate lower than the rate necessary to deliver all events,
	// consider using a dead-letter queue to catch events that are not delivered
	// within 24 hours.
	InvocationRateLimitPerSecond *int64 `min:"1" type:"integer"`

	// A time stamp for the time that the API destination was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the API destination retrieved.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeApiDestinationOutput) GoString added in v1.37.24 

func (s DescribeApiDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApiDestinationOutput) SetApiDestinationArn added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetApiDestinationArn(v string) *DescribeApiDestinationOutput

SetApiDestinationArn sets the ApiDestinationArn field's value.

func (*DescribeApiDestinationOutput) SetApiDestinationState added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetApiDestinationState(v string) *DescribeApiDestinationOutput

SetApiDestinationState sets the ApiDestinationState field's value.

func (*DescribeApiDestinationOutput) SetConnectionArn added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetConnectionArn(v string) *DescribeApiDestinationOutput

SetConnectionArn sets the ConnectionArn field's value.

func (*DescribeApiDestinationOutput) SetCreationTime added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetCreationTime(v time.Time) *DescribeApiDestinationOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeApiDestinationOutput) SetDescription added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetDescription(v string) *DescribeApiDestinationOutput

SetDescription sets the Description field's value.

func (*DescribeApiDestinationOutput) SetHttpMethod added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetHttpMethod(v string) *DescribeApiDestinationOutput

SetHttpMethod sets the HttpMethod field's value.

func (*DescribeApiDestinationOutput) SetInvocationEndpoint added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetInvocationEndpoint(v string) *DescribeApiDestinationOutput

SetInvocationEndpoint sets the InvocationEndpoint field's value.

func (*DescribeApiDestinationOutput) SetInvocationRateLimitPerSecond added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetInvocationRateLimitPerSecond(v int64) *DescribeApiDestinationOutput

SetInvocationRateLimitPerSecond sets the InvocationRateLimitPerSecond field's value.

func (*DescribeApiDestinationOutput) SetLastModifiedTime added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetLastModifiedTime(v time.Time) *DescribeApiDestinationOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DescribeApiDestinationOutput) SetName added in v1.37.24 

func (s *DescribeApiDestinationOutput) SetName(v string) *DescribeApiDestinationOutput

SetName sets the Name field's value.

func (DescribeApiDestinationOutput) String added in v1.37.24 

func (s DescribeApiDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeArchiveInput added in v1.35.22 

type DescribeArchiveInput struct {

	// The name of the archive to retrieve.
	//
	// ArchiveName is a required field
	ArchiveName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeArchiveInput) GoString added in v1.35.22 

func (s DescribeArchiveInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeArchiveInput) SetArchiveName added in v1.35.22 

func (s *DescribeArchiveInput) SetArchiveName(v string) *DescribeArchiveInput

SetArchiveName sets the ArchiveName field's value.

func (DescribeArchiveInput) String added in v1.35.22 

func (s DescribeArchiveInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeArchiveInput) Validate added in v1.35.22 

func (s *DescribeArchiveInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeArchiveOutput added in v1.35.22 

type DescribeArchiveOutput struct {

	// The ARN of the archive.
	ArchiveArn *string `min:"1" type:"string"`

	// The name of the archive.
	ArchiveName *string `min:"1" type:"string"`

	// The time at which the archive was created.
	CreationTime *time.Time `type:"timestamp"`

	// The description of the archive.
	Description *string `type:"string"`

	// The number of events in the archive.
	EventCount *int64 `type:"long"`

	// The event pattern used to filter events sent to the archive.
	EventPattern *string `type:"string"`

	// The ARN of the event source associated with the archive.
	EventSourceArn *string `min:"1" type:"string"`

	// The number of days to retain events for in the archive.
	RetentionDays *int64 `type:"integer"`

	// The size of the archive in bytes.
	SizeBytes *int64 `type:"long"`

	// The state of the archive.
	State *string `type:"string" enum:"ArchiveState"`

	// The reason that the archive is in the state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeArchiveOutput) GoString added in v1.35.22 

func (s DescribeArchiveOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeArchiveOutput) SetArchiveArn added in v1.35.22 

func (s *DescribeArchiveOutput) SetArchiveArn(v string) *DescribeArchiveOutput

SetArchiveArn sets the ArchiveArn field's value.

func (*DescribeArchiveOutput) SetArchiveName added in v1.35.22 

func (s *DescribeArchiveOutput) SetArchiveName(v string) *DescribeArchiveOutput

SetArchiveName sets the ArchiveName field's value.

func (*DescribeArchiveOutput) SetCreationTime added in v1.35.22 

func (s *DescribeArchiveOutput) SetCreationTime(v time.Time) *DescribeArchiveOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeArchiveOutput) SetDescription added in v1.35.22 

func (s *DescribeArchiveOutput) SetDescription(v string) *DescribeArchiveOutput

SetDescription sets the Description field's value.

func (*DescribeArchiveOutput) SetEventCount added in v1.35.22 

func (s *DescribeArchiveOutput) SetEventCount(v int64) *DescribeArchiveOutput

SetEventCount sets the EventCount field's value.

func (*DescribeArchiveOutput) SetEventPattern added in v1.35.22 

func (s *DescribeArchiveOutput) SetEventPattern(v string) *DescribeArchiveOutput

SetEventPattern sets the EventPattern field's value.

func (*DescribeArchiveOutput) SetEventSourceArn added in v1.35.22 

func (s *DescribeArchiveOutput) SetEventSourceArn(v string) *DescribeArchiveOutput

SetEventSourceArn sets the EventSourceArn field's value.

func (*DescribeArchiveOutput) SetRetentionDays added in v1.35.22 

func (s *DescribeArchiveOutput) SetRetentionDays(v int64) *DescribeArchiveOutput

SetRetentionDays sets the RetentionDays field's value.

func (*DescribeArchiveOutput) SetSizeBytes added in v1.35.22 

func (s *DescribeArchiveOutput) SetSizeBytes(v int64) *DescribeArchiveOutput

SetSizeBytes sets the SizeBytes field's value.

func (*DescribeArchiveOutput) SetState added in v1.35.22 

func (s *DescribeArchiveOutput) SetState(v string) *DescribeArchiveOutput

SetState sets the State field's value.

func (*DescribeArchiveOutput) SetStateReason added in v1.35.22 

func (s *DescribeArchiveOutput) SetStateReason(v string) *DescribeArchiveOutput

SetStateReason sets the StateReason field's value.

func (DescribeArchiveOutput) String added in v1.35.22 

func (s DescribeArchiveOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeConnectionInput added in v1.37.24 

type DescribeConnectionInput struct {

	// The name of the connection to retrieve.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeConnectionInput) GoString added in v1.37.24 

func (s DescribeConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionInput) SetName added in v1.37.24 

func (s *DescribeConnectionInput) SetName(v string) *DescribeConnectionInput

SetName sets the Name field's value.

func (DescribeConnectionInput) String added in v1.37.24 

func (s DescribeConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionInput) Validate added in v1.37.24 

func (s *DescribeConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeConnectionOutput added in v1.37.24 

type DescribeConnectionOutput struct {

	// The parameters to use for authorization for the connection.
	AuthParameters *ConnectionAuthResponseParameters `type:"structure"`

	// The type of authorization specified for the connection.
	AuthorizationType *string `type:"string" enum:"ConnectionAuthorizationType"`

	// The ARN of the connection retrieved.
	ConnectionArn *string `min:"1" type:"string"`

	// The state of the connection retrieved.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// A time stamp for the time that the connection was created.
	CreationTime *time.Time `type:"timestamp"`

	// The description for the connection retrieved.
	Description *string `type:"string"`

	// A time stamp for the time that the connection was last authorized.
	LastAuthorizedTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the connection retrieved.
	Name *string `min:"1" type:"string"`

	// The ARN of the secret created from the authorization parameters specified
	// for the connection.
	SecretArn *string `min:"20" type:"string"`

	// The reason that the connection is in the current connection state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConnectionOutput) GoString added in v1.37.24 

func (s DescribeConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionOutput) SetAuthParameters added in v1.37.24 

func (s *DescribeConnectionOutput) SetAuthParameters(v *ConnectionAuthResponseParameters) *DescribeConnectionOutput

SetAuthParameters sets the AuthParameters field's value.

func (*DescribeConnectionOutput) SetAuthorizationType added in v1.37.24 

func (s *DescribeConnectionOutput) SetAuthorizationType(v string) *DescribeConnectionOutput

SetAuthorizationType sets the AuthorizationType field's value.

func (*DescribeConnectionOutput) SetConnectionArn added in v1.37.24 

func (s *DescribeConnectionOutput) SetConnectionArn(v string) *DescribeConnectionOutput

SetConnectionArn sets the ConnectionArn field's value.

func (*DescribeConnectionOutput) SetConnectionState added in v1.37.24 

func (s *DescribeConnectionOutput) SetConnectionState(v string) *DescribeConnectionOutput

SetConnectionState sets the ConnectionState field's value.

func (*DescribeConnectionOutput) SetCreationTime added in v1.37.24 

func (s *DescribeConnectionOutput) SetCreationTime(v time.Time) *DescribeConnectionOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeConnectionOutput) SetDescription added in v1.37.24 

func (s *DescribeConnectionOutput) SetDescription(v string) *DescribeConnectionOutput

SetDescription sets the Description field's value.

func (*DescribeConnectionOutput) SetLastAuthorizedTime added in v1.37.24 

func (s *DescribeConnectionOutput) SetLastAuthorizedTime(v time.Time) *DescribeConnectionOutput

SetLastAuthorizedTime sets the LastAuthorizedTime field's value.

func (*DescribeConnectionOutput) SetLastModifiedTime added in v1.37.24 

func (s *DescribeConnectionOutput) SetLastModifiedTime(v time.Time) *DescribeConnectionOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DescribeConnectionOutput) SetName added in v1.37.24 

func (s *DescribeConnectionOutput) SetName(v string) *DescribeConnectionOutput

SetName sets the Name field's value.

func (*DescribeConnectionOutput) SetSecretArn added in v1.37.24 

func (s *DescribeConnectionOutput) SetSecretArn(v string) *DescribeConnectionOutput

SetSecretArn sets the SecretArn field's value.

func (*DescribeConnectionOutput) SetStateReason added in v1.37.24 

func (s *DescribeConnectionOutput) SetStateReason(v string) *DescribeConnectionOutput

SetStateReason sets the StateReason field's value.

func (DescribeConnectionOutput) String added in v1.37.24 

func (s DescribeConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventBusInput added in v1.10.5 

type DescribeEventBusInput struct {

	// The name or ARN of the event bus to show details for. If you omit this, the
	// default event bus is displayed.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventBusInput) GoString added in v1.10.5 

func (s DescribeEventBusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventBusInput) SetName added in v1.20.19 

func (s *DescribeEventBusInput) SetName(v string) *DescribeEventBusInput

SetName sets the Name field's value.

func (DescribeEventBusInput) String added in v1.10.5 

func (s DescribeEventBusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventBusInput) Validate added in v1.20.19 

func (s *DescribeEventBusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventBusOutput added in v1.10.5 

type DescribeEventBusOutput struct {

	// The Amazon Resource Name (ARN) of the account permitted to write events to
	// the current account.
	Arn *string `type:"string"`

	// The name of the event bus. Currently, this is always default.
	Name *string `type:"string"`

	// The policy that enables the external account to send events to your account.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeEventBusOutput) GoString added in v1.10.5 

func (s DescribeEventBusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventBusOutput) SetArn added in v1.10.5 

func (s *DescribeEventBusOutput) SetArn(v string) *DescribeEventBusOutput

SetArn sets the Arn field's value.

func (*DescribeEventBusOutput) SetName added in v1.10.5 

func (s *DescribeEventBusOutput) SetName(v string) *DescribeEventBusOutput

SetName sets the Name field's value.

func (*DescribeEventBusOutput) SetPolicy added in v1.10.5 

func (s *DescribeEventBusOutput) SetPolicy(v string) *DescribeEventBusOutput

SetPolicy sets the Policy field's value.

func (DescribeEventBusOutput) String added in v1.10.5 

func (s DescribeEventBusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeEventSourceInput added in v1.20.19 

type DescribeEventSourceInput struct {

	// The name of the partner event source to display the details of.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEventSourceInput) GoString added in v1.20.19 

func (s DescribeEventSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventSourceInput) SetName added in v1.20.19 

func (s *DescribeEventSourceInput) SetName(v string) *DescribeEventSourceInput

SetName sets the Name field's value.

func (DescribeEventSourceInput) String added in v1.20.19 

func (s DescribeEventSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventSourceInput) Validate added in v1.20.19 

func (s *DescribeEventSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEventSourceOutput added in v1.20.19 

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 *string `type:"string" enum:"EventSourceState"`
	// contains filtered or unexported fields
}

func (DescribeEventSourceOutput) GoString added in v1.20.19 

func (s DescribeEventSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeEventSourceOutput) SetArn added in v1.20.19 

func (s *DescribeEventSourceOutput) SetArn(v string) *DescribeEventSourceOutput

SetArn sets the Arn field's value.

func (*DescribeEventSourceOutput) SetCreatedBy added in v1.20.19 

func (s *DescribeEventSourceOutput) SetCreatedBy(v string) *DescribeEventSourceOutput

SetCreatedBy sets the CreatedBy field's value.

func (*DescribeEventSourceOutput) SetCreationTime added in v1.20.19 

func (s *DescribeEventSourceOutput) SetCreationTime(v time.Time) *DescribeEventSourceOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeEventSourceOutput) SetExpirationTime added in v1.20.19 

func (s *DescribeEventSourceOutput) SetExpirationTime(v time.Time) *DescribeEventSourceOutput

SetExpirationTime sets the ExpirationTime field's value.

func (*DescribeEventSourceOutput) SetName added in v1.20.19 

func (s *DescribeEventSourceOutput) SetName(v string) *DescribeEventSourceOutput

SetName sets the Name field's value.

func (*DescribeEventSourceOutput) SetState added in v1.20.19 

func (s *DescribeEventSourceOutput) SetState(v string) *DescribeEventSourceOutput

SetState sets the State field's value.

func (DescribeEventSourceOutput) String added in v1.20.19 

func (s DescribeEventSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePartnerEventSourceInput added in v1.20.19 

type DescribePartnerEventSourceInput struct {

	// The name of the event source to display.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePartnerEventSourceInput) GoString added in v1.20.19 

func (s DescribePartnerEventSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePartnerEventSourceInput) SetName added in v1.20.19 

func (s *DescribePartnerEventSourceInput) SetName(v string) *DescribePartnerEventSourceInput

SetName sets the Name field's value.

func (DescribePartnerEventSourceInput) String added in v1.20.19 

func (s DescribePartnerEventSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePartnerEventSourceInput) Validate added in v1.20.19 

func (s *DescribePartnerEventSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribePartnerEventSourceOutput added in v1.20.19 

type DescribePartnerEventSourceOutput struct {

	// The ARN of the event source.
	Arn *string `type:"string"`

	// The name of the event source.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribePartnerEventSourceOutput) GoString added in v1.20.19 

func (s DescribePartnerEventSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePartnerEventSourceOutput) SetArn added in v1.20.19 

func (s *DescribePartnerEventSourceOutput) SetArn(v string) *DescribePartnerEventSourceOutput

SetArn sets the Arn field's value.

func (*DescribePartnerEventSourceOutput) SetName added in v1.20.19 

func (s *DescribePartnerEventSourceOutput) SetName(v string) *DescribePartnerEventSourceOutput

SetName sets the Name field's value.

func (DescribePartnerEventSourceOutput) String added in v1.20.19 

func (s DescribePartnerEventSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReplayInput added in v1.35.22 

type DescribeReplayInput struct {

	// The name of the replay to retrieve.
	//
	// ReplayName is a required field
	ReplayName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeReplayInput) GoString added in v1.35.22 

func (s DescribeReplayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplayInput) SetReplayName added in v1.35.22 

func (s *DescribeReplayInput) SetReplayName(v string) *DescribeReplayInput

SetReplayName sets the ReplayName field's value.

func (DescribeReplayInput) String added in v1.35.22 

func (s DescribeReplayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplayInput) Validate added in v1.35.22 

func (s *DescribeReplayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeReplayOutput added in v1.35.22 

type DescribeReplayOutput struct {

	// The description of the replay.
	Description *string `type:"string"`

	// A ReplayDestination object that contains details about the replay.
	Destination *ReplayDestination `type:"structure"`

	// The time stamp for the last event that was replayed from the archive.
	EventEndTime *time.Time `type:"timestamp"`

	// The time that the event was last replayed.
	EventLastReplayedTime *time.Time `type:"timestamp"`

	// The ARN of the archive events were replayed from.
	EventSourceArn *string `min:"1" type:"string"`

	// The time stamp of the first event that was last replayed from the archive.
	EventStartTime *time.Time `type:"timestamp"`

	// The ARN of the replay.
	ReplayArn *string `min:"1" type:"string"`

	// A time stamp for the time that the replay stopped.
	ReplayEndTime *time.Time `type:"timestamp"`

	// The name of the replay.
	ReplayName *string `min:"1" type:"string"`

	// A time stamp for the time that the replay started.
	ReplayStartTime *time.Time `type:"timestamp"`

	// The current state of the replay.
	State *string `type:"string" enum:"ReplayState"`

	// The reason that the replay is in the current state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeReplayOutput) GoString added in v1.35.22 

func (s DescribeReplayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReplayOutput) SetDescription added in v1.35.22 

func (s *DescribeReplayOutput) SetDescription(v string) *DescribeReplayOutput

SetDescription sets the Description field's value.

func (*DescribeReplayOutput) SetDestination added in v1.35.22 

func (s *DescribeReplayOutput) SetDestination(v *ReplayDestination) *DescribeReplayOutput

SetDestination sets the Destination field's value.

func (*DescribeReplayOutput) SetEventEndTime added in v1.35.22 

func (s *DescribeReplayOutput) SetEventEndTime(v time.Time) *DescribeReplayOutput

SetEventEndTime sets the EventEndTime field's value.

func (*DescribeReplayOutput) SetEventLastReplayedTime added in v1.35.22 

func (s *DescribeReplayOutput) SetEventLastReplayedTime(v time.Time) *DescribeReplayOutput

SetEventLastReplayedTime sets the EventLastReplayedTime field's value.

func (*DescribeReplayOutput) SetEventSourceArn added in v1.35.22 

func (s *DescribeReplayOutput) SetEventSourceArn(v string) *DescribeReplayOutput

SetEventSourceArn sets the EventSourceArn field's value.

func (*DescribeReplayOutput) SetEventStartTime added in v1.35.22 

func (s *DescribeReplayOutput) SetEventStartTime(v time.Time) *DescribeReplayOutput

SetEventStartTime sets the EventStartTime field's value.

func (*DescribeReplayOutput) SetReplayArn added in v1.35.22 

func (s *DescribeReplayOutput) SetReplayArn(v string) *DescribeReplayOutput

SetReplayArn sets the ReplayArn field's value.

func (*DescribeReplayOutput) SetReplayEndTime added in v1.35.22 

func (s *DescribeReplayOutput) SetReplayEndTime(v time.Time) *DescribeReplayOutput

SetReplayEndTime sets the ReplayEndTime field's value.

func (*DescribeReplayOutput) SetReplayName added in v1.35.22 

func (s *DescribeReplayOutput) SetReplayName(v string) *DescribeReplayOutput

SetReplayName sets the ReplayName field's value.

func (*DescribeReplayOutput) SetReplayStartTime added in v1.35.22 

func (s *DescribeReplayOutput) SetReplayStartTime(v time.Time) *DescribeReplayOutput

SetReplayStartTime sets the ReplayStartTime field's value.

func (*DescribeReplayOutput) SetState added in v1.35.22 

func (s *DescribeReplayOutput) SetState(v string) *DescribeReplayOutput

SetState sets the State field's value.

func (*DescribeReplayOutput) SetStateReason added in v1.35.22 

func (s *DescribeReplayOutput) SetStateReason(v string) *DescribeReplayOutput

SetStateReason sets the StateReason field's value.

func (DescribeReplayOutput) String added in v1.35.22 

func (s DescribeReplayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRuleInput 

type DescribeRuleInput struct {

	// The name or ARN 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.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRuleInput) GoString 

func (s DescribeRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleInput) SetEventBusName added in v1.20.19 

func (s *DescribeRuleInput) SetEventBusName(v string) *DescribeRuleInput

SetEventBusName sets the EventBusName field's value.

func (*DescribeRuleInput) SetName added in v1.5.0 

func (s *DescribeRuleInput) SetName(v string) *DescribeRuleInput

SetName sets the Name field's value.

func (DescribeRuleInput) String 

func (s DescribeRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleInput) Validate added in v1.1.21 

func (s *DescribeRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRuleOutput 

type DescribeRuleOutput struct {

	// The Amazon Resource Name (ARN) of the rule.
	Arn *string `min:"1" type:"string"`

	// The account ID of the user that created the rule. If you use PutRule to put
	// a rule on an event bus in another account, the other account is the owner
	// of the rule, and the rule ARN includes the account ID for that account. However,
	// the value for CreatedBy is the account ID as the account that created the
	// rule in the other account.
	CreatedBy *string `min:"1" type:"string"`

	// The description of the rule.
	Description *string `type:"string"`

	// The name of 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 Amazon Web Services service on your
	// behalf, this field displays the principal name of the Amazon Web Services
	// 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 *string `type:"string" enum:"RuleState"`
	// contains filtered or unexported fields
}

func (DescribeRuleOutput) GoString 

func (s DescribeRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleOutput) SetArn added in v1.5.0 

func (s *DescribeRuleOutput) SetArn(v string) *DescribeRuleOutput

SetArn sets the Arn field's value.

func (*DescribeRuleOutput) SetCreatedBy added in v1.35.32 

func (s *DescribeRuleOutput) SetCreatedBy(v string) *DescribeRuleOutput

SetCreatedBy sets the CreatedBy field's value.

func (*DescribeRuleOutput) SetDescription added in v1.5.0 

func (s *DescribeRuleOutput) SetDescription(v string) *DescribeRuleOutput

SetDescription sets the Description field's value.

func (*DescribeRuleOutput) SetEventBusName added in v1.20.19 

func (s *DescribeRuleOutput) SetEventBusName(v string) *DescribeRuleOutput

SetEventBusName sets the EventBusName field's value.

func (*DescribeRuleOutput) SetEventPattern added in v1.5.0 

func (s *DescribeRuleOutput) SetEventPattern(v string) *DescribeRuleOutput

SetEventPattern sets the EventPattern field's value.

func (*DescribeRuleOutput) SetManagedBy added in v1.15.87 

func (s *DescribeRuleOutput) SetManagedBy(v string) *DescribeRuleOutput

SetManagedBy sets the ManagedBy field's value.

func (*DescribeRuleOutput) SetName added in v1.5.0 

func (s *DescribeRuleOutput) SetName(v string) *DescribeRuleOutput

SetName sets the Name field's value.

func (*DescribeRuleOutput) SetRoleArn added in v1.5.0 

func (s *DescribeRuleOutput) SetRoleArn(v string) *DescribeRuleOutput

SetRoleArn sets the RoleArn field's value.

func (*DescribeRuleOutput) SetScheduleExpression added in v1.5.0 

func (s *DescribeRuleOutput) SetScheduleExpression(v string) *DescribeRuleOutput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*DescribeRuleOutput) SetState added in v1.5.0 

func (s *DescribeRuleOutput) SetState(v string) *DescribeRuleOutput

SetState sets the State field's value.

func (DescribeRuleOutput) String 

func (s DescribeRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisableRuleInput 

type DisableRuleInput struct {

	// The name or ARN 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.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisableRuleInput) GoString 

func (s DisableRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableRuleInput) SetEventBusName added in v1.20.19 

func (s *DisableRuleInput) SetEventBusName(v string) *DisableRuleInput

SetEventBusName sets the EventBusName field's value.

func (*DisableRuleInput) SetName added in v1.5.0 

func (s *DisableRuleInput) SetName(v string) *DisableRuleInput

SetName sets the Name field's value.

func (DisableRuleInput) String 

func (s DisableRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisableRuleInput) Validate added in v1.1.21 

func (s *DisableRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableRuleOutput 

type DisableRuleOutput struct {
	// contains filtered or unexported fields
}

func (DisableRuleOutput) GoString 

func (s DisableRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisableRuleOutput) String 

func (s DisableRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EcsParameters added in v1.7.9 

type EcsParameters struct {

	// The capacity provider strategy to use for the task.
	//
	// If a capacityProviderStrategy is specified, the launchType parameter must
	// be omitted. If no capacityProviderStrategy or launchType is specified, the
	// defaultCapacityProviderStrategy for the cluster is used.
	CapacityProviderStrategy []*CapacityProviderStrategyItem `type:"list"`

	// Specifies whether to enable Amazon ECS managed tags for the task. For more
	// information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
	// in the Amazon Elastic Container Service Developer Guide.
	EnableECSManagedTags *bool `type:"boolean"`

	// Whether or not to enable the execute command functionality for the containers
	// in this task. If true, this enables execute command functionality on all
	// containers in the task.
	EnableExecuteCommand *bool `type:"boolean"`

	// 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
	// Fargate witt Amazon ECS is supported. For more information, see Fargate on
	// Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html)
	// in the Amazon Elastic Container Service Developer Guide.
	LaunchType *string `type:"string" enum:"LaunchType"`

	// Use this structure if the Amazon 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"`

	// An array of placement constraint objects to use for the task. You can specify
	// up to 10 constraints per task (including constraints in the task definition
	// and those specified at runtime).
	PlacementConstraints []*PlacementConstraint `type:"list"`

	// The placement strategy objects to use for the task. You can specify a maximum
	// of five strategy rules per task.
	PlacementStrategy []*PlacementStrategy `type:"list"`

	// 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 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"`

	// Specifies whether to propagate the tags from the task definition to the task.
	// If no value is specified, the tags are not propagated. Tags can only be propagated
	// to the task during task creation. To add tags to a task after task creation,
	// use the TagResource API action.
	PropagateTags *string `type:"string" enum:"PropagateTags"`

	// The reference ID to use for the task.
	ReferenceId *string `type:"string"`

	// The metadata that you apply to the task to help you categorize and organize
	// them. Each tag consists of a key and an optional value, both of which you
	// define. To learn more, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags)
	// in the Amazon ECS API Reference.
	Tags []*Tag `type:"list"`

	// The number of tasks to create based on TaskDefinition. The default is 1.
	TaskCount *int64 `min:"1" type:"integer"`

	// The ARN of the task definition to use if the event target is an Amazon ECS
	// task.
	//
	// TaskDefinitionArn is a required field
	TaskDefinitionArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The custom parameters to be used when the target is an Amazon ECS task.

func (EcsParameters) GoString added in v1.7.9 

func (s EcsParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EcsParameters) SetCapacityProviderStrategy added in v1.38.66 

func (s *EcsParameters) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *EcsParameters

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*EcsParameters) SetEnableECSManagedTags added in v1.38.66 

func (s *EcsParameters) SetEnableECSManagedTags(v bool) *EcsParameters

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*EcsParameters) SetEnableExecuteCommand added in v1.38.66 

func (s *EcsParameters) SetEnableExecuteCommand(v bool) *EcsParameters

SetEnableExecuteCommand sets the EnableExecuteCommand field's value.

func (*EcsParameters) SetGroup added in v1.15.20 

func (s *EcsParameters) SetGroup(v string) *EcsParameters

SetGroup sets the Group field's value.

func (*EcsParameters) SetLaunchType added in v1.15.20 

func (s *EcsParameters) SetLaunchType(v string) *EcsParameters

SetLaunchType sets the LaunchType field's value.

func (*EcsParameters) SetNetworkConfiguration added in v1.15.20 

func (s *EcsParameters) SetNetworkConfiguration(v *NetworkConfiguration) *EcsParameters

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*EcsParameters) SetPlacementConstraints added in v1.38.66 

func (s *EcsParameters) SetPlacementConstraints(v []*PlacementConstraint) *EcsParameters

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*EcsParameters) SetPlacementStrategy added in v1.38.66 

func (s *EcsParameters) SetPlacementStrategy(v []*PlacementStrategy) *EcsParameters

SetPlacementStrategy sets the PlacementStrategy field's value.

func (*EcsParameters) SetPlatformVersion added in v1.15.20 

func (s *EcsParameters) SetPlatformVersion(v string) *EcsParameters

SetPlatformVersion sets the PlatformVersion field's value.

func (*EcsParameters) SetPropagateTags added in v1.38.66 

func (s *EcsParameters) SetPropagateTags(v string) *EcsParameters

SetPropagateTags sets the PropagateTags field's value.

func (*EcsParameters) SetReferenceId added in v1.38.66 

func (s *EcsParameters) SetReferenceId(v string) *EcsParameters

SetReferenceId sets the ReferenceId field's value.

func (*EcsParameters) SetTags added in v1.38.66 

func (s *EcsParameters) SetTags(v []*Tag) *EcsParameters

SetTags sets the Tags field's value.

func (*EcsParameters) SetTaskCount added in v1.7.9 

func (s *EcsParameters) SetTaskCount(v int64) *EcsParameters

SetTaskCount sets the TaskCount field's value.

func (*EcsParameters) SetTaskDefinitionArn added in v1.7.9 

func (s *EcsParameters) SetTaskDefinitionArn(v string) *EcsParameters

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (EcsParameters) String added in v1.7.9 

func (s EcsParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EcsParameters) Validate added in v1.7.9 

func (s *EcsParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableRuleInput 

type EnableRuleInput struct {

	// The name or ARN 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.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EnableRuleInput) GoString 

func (s EnableRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableRuleInput) SetEventBusName added in v1.20.19 

func (s *EnableRuleInput) SetEventBusName(v string) *EnableRuleInput

SetEventBusName sets the EventBusName field's value.

func (*EnableRuleInput) SetName added in v1.5.0 

func (s *EnableRuleInput) SetName(v string) *EnableRuleInput

SetName sets the Name field's value.

func (EnableRuleInput) String 

func (s EnableRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EnableRuleInput) Validate added in v1.1.21 

func (s *EnableRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableRuleOutput 

type EnableRuleOutput struct {
	// contains filtered or unexported fields
}

func (EnableRuleOutput) GoString 

func (s EnableRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (EnableRuleOutput) String 

func (s EnableRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventBus added in v1.20.19 

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 Amazon Web
	// Services 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 events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

func (EventBus) GoString added in v1.20.19 

func (s EventBus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventBus) SetArn added in v1.20.19 

func (s *EventBus) SetArn(v string) *EventBus

SetArn sets the Arn field's value.

func (*EventBus) SetName added in v1.20.19 

func (s *EventBus) SetName(v string) *EventBus

SetName sets the Name field's value.

func (*EventBus) SetPolicy added in v1.20.19 

func (s *EventBus) SetPolicy(v string) *EventBus

SetPolicy sets the Policy field's value.

func (EventBus) String added in v1.20.19 

func (s EventBus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EventSource added in v1.20.19 

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 Amazon Web Services
	// 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 *string `type:"string" enum:"EventSourceState"`
	// contains filtered or unexported fields
}

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.

func (EventSource) GoString added in v1.20.19 

func (s EventSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EventSource) SetArn added in v1.20.19 

func (s *EventSource) SetArn(v string) *EventSource

SetArn sets the Arn field's value.

func (*EventSource) SetCreatedBy added in v1.20.19 

func (s *EventSource) SetCreatedBy(v string) *EventSource

SetCreatedBy sets the CreatedBy field's value.

func (*EventSource) SetCreationTime added in v1.20.19 

func (s *EventSource) SetCreationTime(v time.Time) *EventSource

SetCreationTime sets the CreationTime field's value.

func (*EventSource) SetExpirationTime added in v1.20.19 

func (s *EventSource) SetExpirationTime(v time.Time) *EventSource

SetExpirationTime sets the ExpirationTime field's value.

func (*EventSource) SetName added in v1.20.19 

func (s *EventSource) SetName(v string) *EventSource

SetName sets the Name field's value.

func (*EventSource) SetState added in v1.20.19 

func (s *EventSource) SetState(v string) *EventSource

SetState sets the State field's value.

func (EventSource) String added in v1.20.19 

func (s EventSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type HttpParameters added in v1.33.5 

type HttpParameters struct {

	// The headers that need to be sent as part of request invoking the API Gateway
	// REST API or EventBridge ApiDestination.
	HeaderParameters map[string]*string `type:"map"`

	// The path parameter values to be used to populate API Gateway REST API or
	// EventBridge ApiDestination 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 or EventBridge ApiDestination.
	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 or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

func (HttpParameters) GoString added in v1.33.5 

func (s HttpParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*HttpParameters) SetHeaderParameters added in v1.33.5 

func (s *HttpParameters) SetHeaderParameters(v map[string]*string) *HttpParameters

SetHeaderParameters sets the HeaderParameters field's value.

func (*HttpParameters) SetPathParameterValues added in v1.33.5 

func (s *HttpParameters) SetPathParameterValues(v []*string) *HttpParameters

SetPathParameterValues sets the PathParameterValues field's value.

func (*HttpParameters) SetQueryStringParameters added in v1.33.5 

func (s *HttpParameters) SetQueryStringParameters(v map[string]*string) *HttpParameters

SetQueryStringParameters sets the QueryStringParameters field's value.

func (HttpParameters) String added in v1.33.5 

func (s HttpParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IllegalStatusException added in v1.35.22 

type IllegalStatusException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred because a replay can be canceled only when the state is Running or Starting.

func (*IllegalStatusException) Code added in v1.35.22 

func (s *IllegalStatusException) Code() string

Code returns the exception type name.

func (*IllegalStatusException) Error added in v1.35.22 

func (s *IllegalStatusException) Error() string

func (IllegalStatusException) GoString added in v1.35.22 

func (s IllegalStatusException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IllegalStatusException) Message added in v1.35.22 

func (s *IllegalStatusException) Message() string

Message returns the exception's message.

func (*IllegalStatusException) OrigErr added in v1.35.22 

func (s *IllegalStatusException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IllegalStatusException) RequestID added in v1.35.22 

func (s *IllegalStatusException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IllegalStatusException) StatusCode added in v1.35.22 

func (s *IllegalStatusException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IllegalStatusException) String added in v1.35.22 

func (s IllegalStatusException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InputTransformer added in v1.7.9 

type InputTransformer struct {

	// Map of JSON paths to be extracted from the event. You can then insert these
	// in the template in InputTemplate to produce the output 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 100 key-value pairs. You must use JSON dot
	// notation, not bracket notation.
	//
	// The keys cannot start with "Amazon Web Services."
	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.
	//
	// 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>\""
	//
	// }
	//
	// The InputTemplate can also be valid JSON with varibles in quotes or out,
	// as in the following example:
	//
	// "InputTransformer":
	//
	// {
	//
	// "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
	//
	// "InputTemplate": '{"myInstance": <instance>,"myStatus": "<instance> is in
	// state \"<status>\""}'
	//
	// }
	//
	// InputTemplate is a required field
	InputTemplate *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

func (InputTransformer) GoString added in v1.7.9 

func (s InputTransformer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputTransformer) SetInputPathsMap added in v1.7.9 

func (s *InputTransformer) SetInputPathsMap(v map[string]*string) *InputTransformer

SetInputPathsMap sets the InputPathsMap field's value.

func (*InputTransformer) SetInputTemplate added in v1.7.9 

func (s *InputTransformer) SetInputTemplate(v string) *InputTransformer

SetInputTemplate sets the InputTemplate field's value.

func (InputTransformer) String added in v1.7.9 

func (s InputTransformer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InputTransformer) Validate added in v1.7.9 

func (s *InputTransformer) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalException added in v1.28.0 

type InternalException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This exception occurs due to unexpected causes.

func (*InternalException) Code added in v1.28.0 

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error added in v1.28.0 

func (s *InternalException) Error() string

func (InternalException) GoString added in v1.28.0 

func (s InternalException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalException) Message added in v1.28.0 

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr added in v1.28.0 

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID added in v1.28.0 

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode added in v1.28.0 

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String added in v1.28.0 

func (s InternalException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidEventPatternException added in v1.28.0 

type InvalidEventPatternException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The event pattern is not valid.

func (*InvalidEventPatternException) Code added in v1.28.0 

func (s *InvalidEventPatternException) Code() string

Code returns the exception type name.

func (*InvalidEventPatternException) Error added in v1.28.0 

func (s *InvalidEventPatternException) Error() string

func (InvalidEventPatternException) GoString added in v1.28.0 

func (s InvalidEventPatternException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidEventPatternException) Message added in v1.28.0 

func (s *InvalidEventPatternException) Message() string

Message returns the exception's message.

func (*InvalidEventPatternException) OrigErr added in v1.28.0 

func (s *InvalidEventPatternException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidEventPatternException) RequestID added in v1.28.0 

func (s *InvalidEventPatternException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidEventPatternException) StatusCode added in v1.28.0 

func (s *InvalidEventPatternException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidEventPatternException) String added in v1.28.0 

func (s InvalidEventPatternException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidStateException added in v1.28.0 

type InvalidStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified state is not a valid state for an event source.

func (*InvalidStateException) Code added in v1.28.0 

func (s *InvalidStateException) Code() string

Code returns the exception type name.

func (*InvalidStateException) Error added in v1.28.0 

func (s *InvalidStateException) Error() string

func (InvalidStateException) GoString added in v1.28.0 

func (s InvalidStateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidStateException) Message added in v1.28.0 

func (s *InvalidStateException) Message() string

Message returns the exception's message.

func (*InvalidStateException) OrigErr added in v1.28.0 

func (s *InvalidStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidStateException) RequestID added in v1.28.0 

func (s *InvalidStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidStateException) StatusCode added in v1.28.0 

func (s *InvalidStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidStateException) String added in v1.28.0 

func (s InvalidStateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KinesisParameters added in v1.7.9 

type KinesisParameters struct {

	// The JSON path to be extracted from the event and used as the partition key.
	// For more information, see Amazon Kinesis Streams Key Concepts (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html#partition-key)
	// in the Amazon Kinesis Streams Developer Guide.
	//
	// PartitionKeyPath is a required field
	PartitionKeyPath *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

func (KinesisParameters) GoString added in v1.7.9 

func (s KinesisParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KinesisParameters) SetPartitionKeyPath added in v1.7.9 

func (s *KinesisParameters) SetPartitionKeyPath(v string) *KinesisParameters

SetPartitionKeyPath sets the PartitionKeyPath field's value.

func (KinesisParameters) String added in v1.7.9 

func (s KinesisParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KinesisParameters) Validate added in v1.7.9 

func (s *KinesisParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LimitExceededException added in v1.28.0 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request failed because it attempted to create resource beyond the allowed service quota.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListApiDestinationsInput added in v1.37.24 

type ListApiDestinationsInput struct {

	// The ARN of the connection specified for the API destination.
	ConnectionArn *string `min:"1" type:"string"`

	// The maximum number of API destinations to include in the response.
	Limit *int64 `min:"1" type:"integer"`

	// A name prefix to filter results returned. Only API destinations with a name
	// that starts with the prefix are returned.
	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 (ListApiDestinationsInput) GoString added in v1.37.24 

func (s ListApiDestinationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListApiDestinationsInput) SetConnectionArn added in v1.37.24 

func (s *ListApiDestinationsInput) SetConnectionArn(v string) *ListApiDestinationsInput

SetConnectionArn sets the ConnectionArn field's value.

func (*ListApiDestinationsInput) SetLimit added in v1.37.24 

func (s *ListApiDestinationsInput) SetLimit(v int64) *ListApiDestinationsInput

SetLimit sets the Limit field's value.

func (*ListApiDestinationsInput) SetNamePrefix added in v1.37.24 

func (s *ListApiDestinationsInput) SetNamePrefix(v string) *ListApiDestinationsInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListApiDestinationsInput) SetNextToken added in v1.37.24 

func (s *ListApiDestinationsInput) SetNextToken(v string) *ListApiDestinationsInput

SetNextToken sets the NextToken field's value.

func (ListApiDestinationsInput) String added in v1.37.24 

func (s ListApiDestinationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListApiDestinationsInput) Validate added in v1.37.24 

func (s *ListApiDestinationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListApiDestinationsOutput added in v1.37.24 

type ListApiDestinationsOutput struct {

	// An array of ApiDestination objects that include information about an API
	// destination.
	ApiDestinations []*ApiDestination `type:"list"`

	// A token you can use in a subsequent request to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListApiDestinationsOutput) GoString added in v1.37.24 

func (s ListApiDestinationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListApiDestinationsOutput) SetApiDestinations added in v1.37.24 

func (s *ListApiDestinationsOutput) SetApiDestinations(v []*ApiDestination) *ListApiDestinationsOutput

SetApiDestinations sets the ApiDestinations field's value.

func (*ListApiDestinationsOutput) SetNextToken added in v1.37.24 

func (s *ListApiDestinationsOutput) SetNextToken(v string) *ListApiDestinationsOutput

SetNextToken sets the NextToken field's value.

func (ListApiDestinationsOutput) String added in v1.37.24 

func (s ListApiDestinationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListArchivesInput added in v1.35.22 

type ListArchivesInput struct {

	// The ARN of the event source associated with the archive.
	EventSourceArn *string `min:"1" type:"string"`

	// The maximum number of results to return.
	Limit *int64 `min:"1" type:"integer"`

	// A name prefix to filter the archives returned. Only archives with name that
	// match the prefix are returned.
	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"`

	// The state of the archive.
	State *string `type:"string" enum:"ArchiveState"`
	// contains filtered or unexported fields
}

func (ListArchivesInput) GoString added in v1.35.22 

func (s ListArchivesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListArchivesInput) SetEventSourceArn added in v1.35.22 

func (s *ListArchivesInput) SetEventSourceArn(v string) *ListArchivesInput

SetEventSourceArn sets the EventSourceArn field's value.

func (*ListArchivesInput) SetLimit added in v1.35.22 

func (s *ListArchivesInput) SetLimit(v int64) *ListArchivesInput

SetLimit sets the Limit field's value.

func (*ListArchivesInput) SetNamePrefix added in v1.35.22 

func (s *ListArchivesInput) SetNamePrefix(v string) *ListArchivesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListArchivesInput) SetNextToken added in v1.35.22 

func (s *ListArchivesInput) SetNextToken(v string) *ListArchivesInput

SetNextToken sets the NextToken field's value.

func (*ListArchivesInput) SetState added in v1.35.22 

func (s *ListArchivesInput) SetState(v string) *ListArchivesInput

SetState sets the State field's value.

func (ListArchivesInput) String added in v1.35.22 

func (s ListArchivesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListArchivesInput) Validate added in v1.35.22 

func (s *ListArchivesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListArchivesOutput added in v1.35.22 

type ListArchivesOutput struct {

	// An array of Archive objects that include details about an archive.
	Archives []*Archive `type:"list"`

	// 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 (ListArchivesOutput) GoString added in v1.35.22 

func (s ListArchivesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListArchivesOutput) SetArchives added in v1.35.22 

func (s *ListArchivesOutput) SetArchives(v []*Archive) *ListArchivesOutput

SetArchives sets the Archives field's value.

func (*ListArchivesOutput) SetNextToken added in v1.35.22 

func (s *ListArchivesOutput) SetNextToken(v string) *ListArchivesOutput

SetNextToken sets the NextToken field's value.

func (ListArchivesOutput) String added in v1.35.22 

func (s ListArchivesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListConnectionsInput added in v1.37.24 

type ListConnectionsInput struct {

	// The state of the connection.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// The maximum number of connections to return.
	Limit *int64 `min:"1" type:"integer"`

	// A name prefix to filter results returned. Only connections with a name that
	// starts with the prefix are returned.
	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 (ListConnectionsInput) GoString added in v1.37.24 

func (s ListConnectionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConnectionsInput) SetConnectionState added in v1.37.24 

func (s *ListConnectionsInput) SetConnectionState(v string) *ListConnectionsInput

SetConnectionState sets the ConnectionState field's value.

func (*ListConnectionsInput) SetLimit added in v1.37.24 

func (s *ListConnectionsInput) SetLimit(v int64) *ListConnectionsInput

SetLimit sets the Limit field's value.

func (*ListConnectionsInput) SetNamePrefix added in v1.37.24 

func (s *ListConnectionsInput) SetNamePrefix(v string) *ListConnectionsInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListConnectionsInput) SetNextToken added in v1.37.24 

func (s *ListConnectionsInput) SetNextToken(v string) *ListConnectionsInput

SetNextToken sets the NextToken field's value.

func (ListConnectionsInput) String added in v1.37.24 

func (s ListConnectionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConnectionsInput) Validate added in v1.37.24 

func (s *ListConnectionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListConnectionsOutput added in v1.37.24 

type ListConnectionsOutput struct {

	// An array of connections objects that include details about the connections.
	Connections []*Connection `type:"list"`

	// A token you can use in a subsequent request to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListConnectionsOutput) GoString added in v1.37.24 

func (s ListConnectionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListConnectionsOutput) SetConnections added in v1.37.24 

func (s *ListConnectionsOutput) SetConnections(v []*Connection) *ListConnectionsOutput

SetConnections sets the Connections field's value.

func (*ListConnectionsOutput) SetNextToken added in v1.37.24 

func (s *ListConnectionsOutput) SetNextToken(v string) *ListConnectionsOutput

SetNextToken sets the NextToken field's value.

func (ListConnectionsOutput) String added in v1.37.24 

func (s ListConnectionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEventBusesInput added in v1.20.19 

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) GoString added in v1.20.19 

func (s ListEventBusesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEventBusesInput) SetLimit added in v1.20.19 

func (s *ListEventBusesInput) SetLimit(v int64) *ListEventBusesInput

SetLimit sets the Limit field's value.

func (*ListEventBusesInput) SetNamePrefix added in v1.20.19 

func (s *ListEventBusesInput) SetNamePrefix(v string) *ListEventBusesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListEventBusesInput) SetNextToken added in v1.20.19 

func (s *ListEventBusesInput) SetNextToken(v string) *ListEventBusesInput

SetNextToken sets the NextToken field's value.

func (ListEventBusesInput) String added in v1.20.19 

func (s ListEventBusesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEventBusesInput) Validate added in v1.20.19 

func (s *ListEventBusesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEventBusesOutput added in v1.20.19 

type ListEventBusesOutput struct {

	// This list of event buses.
	EventBuses []*EventBus `type:"list"`

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventBusesOutput) GoString added in v1.20.19 

func (s ListEventBusesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEventBusesOutput) SetEventBuses added in v1.20.19 

func (s *ListEventBusesOutput) SetEventBuses(v []*EventBus) *ListEventBusesOutput

SetEventBuses sets the EventBuses field's value.

func (*ListEventBusesOutput) SetNextToken added in v1.20.19 

func (s *ListEventBusesOutput) SetNextToken(v string) *ListEventBusesOutput

SetNextToken sets the NextToken field's value.

func (ListEventBusesOutput) String added in v1.20.19 

func (s ListEventBusesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListEventSourcesInput added in v1.20.19 

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) GoString added in v1.20.19 

func (s ListEventSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEventSourcesInput) SetLimit added in v1.20.19 

func (s *ListEventSourcesInput) SetLimit(v int64) *ListEventSourcesInput

SetLimit sets the Limit field's value.

func (*ListEventSourcesInput) SetNamePrefix added in v1.20.19 

func (s *ListEventSourcesInput) SetNamePrefix(v string) *ListEventSourcesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListEventSourcesInput) SetNextToken added in v1.20.19 

func (s *ListEventSourcesInput) SetNextToken(v string) *ListEventSourcesInput

SetNextToken sets the NextToken field's value.

func (ListEventSourcesInput) String added in v1.20.19 

func (s ListEventSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEventSourcesInput) Validate added in v1.20.19 

func (s *ListEventSourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEventSourcesOutput added in v1.20.19 

type ListEventSourcesOutput struct {

	// The list of event sources.
	EventSources []*EventSource `type:"list"`

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListEventSourcesOutput) GoString added in v1.20.19 

func (s ListEventSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListEventSourcesOutput) SetEventSources added in v1.20.19 

func (s *ListEventSourcesOutput) SetEventSources(v []*EventSource) *ListEventSourcesOutput

SetEventSources sets the EventSources field's value.

func (*ListEventSourcesOutput) SetNextToken added in v1.20.19 

func (s *ListEventSourcesOutput) SetNextToken(v string) *ListEventSourcesOutput

SetNextToken sets the NextToken field's value.

func (ListEventSourcesOutput) String added in v1.20.19 

func (s ListEventSourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPartnerEventSourceAccountsInput added in v1.20.19 

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) GoString added in v1.20.19 

func (s ListPartnerEventSourceAccountsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPartnerEventSourceAccountsInput) SetEventSourceName added in v1.20.19 

func (s *ListPartnerEventSourceAccountsInput) SetEventSourceName(v string) *ListPartnerEventSourceAccountsInput

SetEventSourceName sets the EventSourceName field's value.

func (*ListPartnerEventSourceAccountsInput) SetLimit added in v1.20.19 

func (s *ListPartnerEventSourceAccountsInput) SetLimit(v int64) *ListPartnerEventSourceAccountsInput

SetLimit sets the Limit field's value.

func (*ListPartnerEventSourceAccountsInput) SetNextToken added in v1.20.19 

func (s *ListPartnerEventSourceAccountsInput) SetNextToken(v string) *ListPartnerEventSourceAccountsInput

SetNextToken sets the NextToken field's value.

func (ListPartnerEventSourceAccountsInput) String added in v1.20.19 

func (s ListPartnerEventSourceAccountsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPartnerEventSourceAccountsInput) Validate added in v1.20.19 

func (s *ListPartnerEventSourceAccountsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPartnerEventSourceAccountsOutput added in v1.20.19 

type ListPartnerEventSourceAccountsOutput struct {

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`

	// The list of partner event sources returned by the operation.
	PartnerEventSourceAccounts []*PartnerEventSourceAccount `type:"list"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourceAccountsOutput) GoString added in v1.20.19 

func (s ListPartnerEventSourceAccountsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPartnerEventSourceAccountsOutput) SetNextToken added in v1.20.19 

func (s *ListPartnerEventSourceAccountsOutput) SetNextToken(v string) *ListPartnerEventSourceAccountsOutput

SetNextToken sets the NextToken field's value.

func (*ListPartnerEventSourceAccountsOutput) SetPartnerEventSourceAccounts added in v1.20.19 

func (s *ListPartnerEventSourceAccountsOutput) SetPartnerEventSourceAccounts(v []*PartnerEventSourceAccount) *ListPartnerEventSourceAccountsOutput

SetPartnerEventSourceAccounts sets the PartnerEventSourceAccounts field's value.

func (ListPartnerEventSourceAccountsOutput) String added in v1.20.19 

func (s ListPartnerEventSourceAccountsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPartnerEventSourcesInput added in v1.20.19 

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) GoString added in v1.20.19 

func (s ListPartnerEventSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPartnerEventSourcesInput) SetLimit added in v1.20.19 

func (s *ListPartnerEventSourcesInput) SetLimit(v int64) *ListPartnerEventSourcesInput

SetLimit sets the Limit field's value.

func (*ListPartnerEventSourcesInput) SetNamePrefix added in v1.20.19 

func (s *ListPartnerEventSourcesInput) SetNamePrefix(v string) *ListPartnerEventSourcesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListPartnerEventSourcesInput) SetNextToken added in v1.20.19 

func (s *ListPartnerEventSourcesInput) SetNextToken(v string) *ListPartnerEventSourcesInput

SetNextToken sets the NextToken field's value.

func (ListPartnerEventSourcesInput) String added in v1.20.19 

func (s ListPartnerEventSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPartnerEventSourcesInput) Validate added in v1.20.19 

func (s *ListPartnerEventSourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPartnerEventSourcesOutput added in v1.20.19 

type ListPartnerEventSourcesOutput struct {

	// A token you can use in a subsequent operation to retrieve the next set of
	// results.
	NextToken *string `min:"1" type:"string"`

	// The list of partner event sources returned by the operation.
	PartnerEventSources []*PartnerEventSource `type:"list"`
	// contains filtered or unexported fields
}

func (ListPartnerEventSourcesOutput) GoString added in v1.20.19 

func (s ListPartnerEventSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPartnerEventSourcesOutput) SetNextToken added in v1.20.19 

func (s *ListPartnerEventSourcesOutput) SetNextToken(v string) *ListPartnerEventSourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListPartnerEventSourcesOutput) SetPartnerEventSources added in v1.20.19 

func (s *ListPartnerEventSourcesOutput) SetPartnerEventSources(v []*PartnerEventSource) *ListPartnerEventSourcesOutput

SetPartnerEventSources sets the PartnerEventSources field's value.

func (ListPartnerEventSourcesOutput) String added in v1.20.19 

func (s ListPartnerEventSourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListReplaysInput added in v1.35.22 

type ListReplaysInput struct {

	// The ARN of the archive from which the events are replayed.
	EventSourceArn *string `min:"1" type:"string"`

	// The maximum number of replays to retrieve.
	Limit *int64 `min:"1" type:"integer"`

	// A name prefix to filter the replays returned. Only replays with name that
	// match the prefix are returned.
	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"`

	// The state of the replay.
	State *string `type:"string" enum:"ReplayState"`
	// contains filtered or unexported fields
}

func (ListReplaysInput) GoString added in v1.35.22 

func (s ListReplaysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReplaysInput) SetEventSourceArn added in v1.35.22 

func (s *ListReplaysInput) SetEventSourceArn(v string) *ListReplaysInput

SetEventSourceArn sets the EventSourceArn field's value.

func (*ListReplaysInput) SetLimit added in v1.35.22 

func (s *ListReplaysInput) SetLimit(v int64) *ListReplaysInput

SetLimit sets the Limit field's value.

func (*ListReplaysInput) SetNamePrefix added in v1.35.22 

func (s *ListReplaysInput) SetNamePrefix(v string) *ListReplaysInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListReplaysInput) SetNextToken added in v1.35.22 

func (s *ListReplaysInput) SetNextToken(v string) *ListReplaysInput

SetNextToken sets the NextToken field's value.

func (*ListReplaysInput) SetState added in v1.35.22 

func (s *ListReplaysInput) SetState(v string) *ListReplaysInput

SetState sets the State field's value.

func (ListReplaysInput) String added in v1.35.22 

func (s ListReplaysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReplaysInput) Validate added in v1.35.22 

func (s *ListReplaysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListReplaysOutput added in v1.35.22 

type ListReplaysOutput struct {

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

	// An array of Replay objects that contain information about the replay.
	Replays []*Replay `type:"list"`
	// contains filtered or unexported fields
}

func (ListReplaysOutput) GoString added in v1.35.22 

func (s ListReplaysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReplaysOutput) SetNextToken added in v1.35.22 

func (s *ListReplaysOutput) SetNextToken(v string) *ListReplaysOutput

SetNextToken sets the NextToken field's value.

func (*ListReplaysOutput) SetReplays added in v1.35.22 

func (s *ListReplaysOutput) SetReplays(v []*Replay) *ListReplaysOutput

SetReplays sets the Replays field's value.

func (ListReplaysOutput) String added in v1.35.22 

func (s ListReplaysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRuleNamesByTargetInput 

type ListRuleNamesByTargetInput struct {

	// The name or ARN of the event bus to list rules for. 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 Amazon Resource Name (ARN) of the target resource.
	//
	// TargetArn is a required field
	TargetArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListRuleNamesByTargetInput) GoString 

func (s ListRuleNamesByTargetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleNamesByTargetInput) SetEventBusName added in v1.20.19 

func (s *ListRuleNamesByTargetInput) SetEventBusName(v string) *ListRuleNamesByTargetInput

SetEventBusName sets the EventBusName field's value.

func (*ListRuleNamesByTargetInput) SetLimit added in v1.5.0 

func (s *ListRuleNamesByTargetInput) SetLimit(v int64) *ListRuleNamesByTargetInput

SetLimit sets the Limit field's value.

func (*ListRuleNamesByTargetInput) SetNextToken added in v1.5.0 

func (s *ListRuleNamesByTargetInput) SetNextToken(v string) *ListRuleNamesByTargetInput

SetNextToken sets the NextToken field's value.

func (*ListRuleNamesByTargetInput) SetTargetArn added in v1.5.0 

func (s *ListRuleNamesByTargetInput) SetTargetArn(v string) *ListRuleNamesByTargetInput

SetTargetArn sets the TargetArn field's value.

func (ListRuleNamesByTargetInput) String 

func (s ListRuleNamesByTargetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleNamesByTargetInput) Validate added in v1.1.21 

func (s *ListRuleNamesByTargetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRuleNamesByTargetOutput 

type ListRuleNamesByTargetOutput struct {

	// Indicates whether there are additional results to retrieve. If there are
	// no more results, the value is null.
	NextToken *string `min:"1" type:"string"`

	// The names of the rules that can invoke the given target.
	RuleNames []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListRuleNamesByTargetOutput) GoString 

func (s ListRuleNamesByTargetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleNamesByTargetOutput) SetNextToken added in v1.5.0 

func (s *ListRuleNamesByTargetOutput) SetNextToken(v string) *ListRuleNamesByTargetOutput

SetNextToken sets the NextToken field's value.

func (*ListRuleNamesByTargetOutput) SetRuleNames added in v1.5.0 

func (s *ListRuleNamesByTargetOutput) SetRuleNames(v []*string) *ListRuleNamesByTargetOutput

SetRuleNames sets the RuleNames field's value.

func (ListRuleNamesByTargetOutput) String 

func (s ListRuleNamesByTargetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRulesInput 

type ListRulesInput struct {

	// The name or ARN of the event bus to list the rules for. 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 prefix matching the rule name.
	NamePrefix *string `min:"1" type:"string"`

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListRulesInput) GoString 

func (s ListRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRulesInput) SetEventBusName added in v1.20.19 

func (s *ListRulesInput) SetEventBusName(v string) *ListRulesInput

SetEventBusName sets the EventBusName field's value.

func (*ListRulesInput) SetLimit added in v1.5.0 

func (s *ListRulesInput) SetLimit(v int64) *ListRulesInput

SetLimit sets the Limit field's value.

func (*ListRulesInput) SetNamePrefix added in v1.5.0 

func (s *ListRulesInput) SetNamePrefix(v string) *ListRulesInput

SetNamePrefix sets the NamePrefix field's value.

func (*ListRulesInput) SetNextToken added in v1.5.0 

func (s *ListRulesInput) SetNextToken(v string) *ListRulesInput

SetNextToken sets the NextToken field's value.

func (ListRulesInput) String 

func (s ListRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRulesInput) Validate added in v1.1.21 

func (s *ListRulesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRulesOutput 

type ListRulesOutput struct {

	// Indicates whether there are additional results to retrieve. If there are
	// no more results, the value is null.
	NextToken *string `min:"1" type:"string"`

	// The rules that match the specified criteria.
	Rules []*Rule `type:"list"`
	// contains filtered or unexported fields
}

func (ListRulesOutput) GoString 

func (s ListRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRulesOutput) SetNextToken added in v1.5.0 

func (s *ListRulesOutput) SetNextToken(v string) *ListRulesOutput

SetNextToken sets the NextToken field's value.

func (*ListRulesOutput) SetRules added in v1.5.0 

func (s *ListRulesOutput) SetRules(v []*Rule) *ListRulesOutput

SetRules sets the Rules field's value.

func (ListRulesOutput) String 

func (s ListRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.19.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) GoString added in v1.19.0 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceARN added in v1.19.0 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.19.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.19.0 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.19.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) GoString added in v1.19.0 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.19.0 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.19.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTargetsByRuleInput 

type ListTargetsByRuleInput struct {

	// The name or ARN 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 maximum number of results to return.
	Limit *int64 `min:"1" type:"integer"`

	// The token returned by a previous call to retrieve the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The name of the rule.
	//
	// Rule is a required field
	Rule *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTargetsByRuleInput) GoString 

func (s ListTargetsByRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsByRuleInput) SetEventBusName added in v1.20.19 

func (s *ListTargetsByRuleInput) SetEventBusName(v string) *ListTargetsByRuleInput

SetEventBusName sets the EventBusName field's value.

func (*ListTargetsByRuleInput) SetLimit added in v1.5.0 

func (s *ListTargetsByRuleInput) SetLimit(v int64) *ListTargetsByRuleInput

SetLimit sets the Limit field's value.

func (*ListTargetsByRuleInput) SetNextToken added in v1.5.0 

func (s *ListTargetsByRuleInput) SetNextToken(v string) *ListTargetsByRuleInput

SetNextToken sets the NextToken field's value.

func (*ListTargetsByRuleInput) SetRule added in v1.5.0 

func (s *ListTargetsByRuleInput) SetRule(v string) *ListTargetsByRuleInput

SetRule sets the Rule field's value.

func (ListTargetsByRuleInput) String 

func (s ListTargetsByRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsByRuleInput) Validate added in v1.1.21 

func (s *ListTargetsByRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTargetsByRuleOutput 

type ListTargetsByRuleOutput struct {

	// Indicates whether there are additional results to retrieve. If there are
	// no more results, the value is null.
	NextToken *string `min:"1" type:"string"`

	// The targets assigned to the rule.
	Targets []*Target `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTargetsByRuleOutput) GoString 

func (s ListTargetsByRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTargetsByRuleOutput) SetNextToken added in v1.5.0 

func (s *ListTargetsByRuleOutput) SetNextToken(v string) *ListTargetsByRuleOutput

SetNextToken sets the NextToken field's value.

func (*ListTargetsByRuleOutput) SetTargets added in v1.5.0 

func (s *ListTargetsByRuleOutput) SetTargets(v []*Target) *ListTargetsByRuleOutput

SetTargets sets the Targets field's value.

func (ListTargetsByRuleOutput) String 

func (s ListTargetsByRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ManagedRuleException added in v1.28.0 

type ManagedRuleException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This rule was created by an Amazon Web Services 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.

func (*ManagedRuleException) Code added in v1.28.0 

func (s *ManagedRuleException) Code() string

Code returns the exception type name.

func (*ManagedRuleException) Error added in v1.28.0 

func (s *ManagedRuleException) Error() string

func (ManagedRuleException) GoString added in v1.28.0 

func (s ManagedRuleException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ManagedRuleException) Message added in v1.28.0 

func (s *ManagedRuleException) Message() string

Message returns the exception's message.

func (*ManagedRuleException) OrigErr added in v1.28.0 

func (s *ManagedRuleException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ManagedRuleException) RequestID added in v1.28.0 

func (s *ManagedRuleException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ManagedRuleException) StatusCode added in v1.28.0 

func (s *ManagedRuleException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ManagedRuleException) String added in v1.28.0 

func (s ManagedRuleException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NetworkConfiguration added in v1.15.20 

type NetworkConfiguration struct {

	// Use this structure to specify the VPC subnets and security groups for the
	// task, and whether a public IP address is to be used. This structure is relevant
	// only for ECS tasks that use the awsvpc network mode.
	AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

This structure specifies the network configuration for an ECS task.

func (NetworkConfiguration) GoString added in v1.15.20 

func (s NetworkConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkConfiguration) SetAwsvpcConfiguration added in v1.15.20 

func (s *NetworkConfiguration) SetAwsvpcConfiguration(v *AwsVpcConfiguration) *NetworkConfiguration

SetAwsvpcConfiguration sets the AwsvpcConfiguration field's value.

func (NetworkConfiguration) String added in v1.15.20 

func (s NetworkConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NetworkConfiguration) Validate added in v1.15.20 

func (s *NetworkConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OperationDisabledException added in v1.33.5 

type OperationDisabledException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The operation you are attempting is not available in this region.

func (*OperationDisabledException) Code added in v1.33.5 

func (s *OperationDisabledException) Code() string

Code returns the exception type name.

func (*OperationDisabledException) Error added in v1.33.5 

func (s *OperationDisabledException) Error() string

func (OperationDisabledException) GoString added in v1.33.5 

func (s OperationDisabledException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperationDisabledException) Message added in v1.33.5 

func (s *OperationDisabledException) Message() string

Message returns the exception's message.

func (*OperationDisabledException) OrigErr added in v1.33.5 

func (s *OperationDisabledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationDisabledException) RequestID added in v1.33.5 

func (s *OperationDisabledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationDisabledException) StatusCode added in v1.33.5 

func (s *OperationDisabledException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperationDisabledException) String added in v1.33.5 

func (s OperationDisabledException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PartnerEventSource added in v1.20.19 

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 Amazon Web Services account can receive events from the partner's applications or services.

func (PartnerEventSource) GoString added in v1.20.19 

func (s PartnerEventSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PartnerEventSource) SetArn added in v1.20.19 

func (s *PartnerEventSource) SetArn(v string) *PartnerEventSource

SetArn sets the Arn field's value.

func (*PartnerEventSource) SetName added in v1.20.19 

func (s *PartnerEventSource) SetName(v string) *PartnerEventSource

SetName sets the Name field's value.

func (PartnerEventSource) String added in v1.20.19 

func (s PartnerEventSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PartnerEventSourceAccount added in v1.20.19 

type PartnerEventSourceAccount struct {

	// The Amazon Web Services 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 Amazon Web Services
	// 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 *string `type:"string" enum:"EventSourceState"`
	// contains filtered or unexported fields
}

The Amazon Web Services account that a partner event source has been offered to.

func (PartnerEventSourceAccount) GoString added in v1.20.19 

func (s PartnerEventSourceAccount) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PartnerEventSourceAccount) SetAccount added in v1.20.19 

func (s *PartnerEventSourceAccount) SetAccount(v string) *PartnerEventSourceAccount

SetAccount sets the Account field's value.

func (*PartnerEventSourceAccount) SetCreationTime added in v1.20.19 

func (s *PartnerEventSourceAccount) SetCreationTime(v time.Time) *PartnerEventSourceAccount

SetCreationTime sets the CreationTime field's value.

func (*PartnerEventSourceAccount) SetExpirationTime added in v1.20.19 

func (s *PartnerEventSourceAccount) SetExpirationTime(v time.Time) *PartnerEventSourceAccount

SetExpirationTime sets the ExpirationTime field's value.

func (*PartnerEventSourceAccount) SetState added in v1.20.19 

func (s *PartnerEventSourceAccount) SetState(v string) *PartnerEventSourceAccount

SetState sets the State field's value.

func (PartnerEventSourceAccount) String added in v1.20.19 

func (s PartnerEventSourceAccount) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlacementConstraint added in v1.38.66 

type PlacementConstraint struct {

	// A cluster query language expression to apply to the constraint. You cannot
	// specify an expression if the constraint type is distinctInstance. To learn
	// more, see Cluster Query Language (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html)
	// in the Amazon Elastic Container Service Developer Guide.
	Expression *string `locationName:"expression" type:"string"`

	// The type of constraint. Use distinctInstance to ensure that each task in
	// a particular group is running on a different container instance. Use memberOf
	// to restrict the selection to a group of valid candidates.
	Type *string `locationName:"type" type:"string" enum:"PlacementConstraintType"`
	// contains filtered or unexported fields
}

An object representing a constraint on task placement. To learn more, see Task Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide.

func (PlacementConstraint) GoString added in v1.38.66 

func (s PlacementConstraint) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlacementConstraint) SetExpression added in v1.38.66 

func (s *PlacementConstraint) SetExpression(v string) *PlacementConstraint

SetExpression sets the Expression field's value.

func (*PlacementConstraint) SetType added in v1.38.66 

func (s *PlacementConstraint) SetType(v string) *PlacementConstraint

SetType sets the Type field's value.

func (PlacementConstraint) String added in v1.38.66 

func (s PlacementConstraint) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlacementStrategy added in v1.38.66 

type PlacementStrategy struct {

	// The field to apply the placement strategy against. For the spread placement
	// strategy, valid values are instanceId (or host, which has the same effect),
	// or any platform or custom attribute that is applied to a container instance,
	// such as attribute:ecs.availability-zone. For the binpack placement strategy,
	// valid values are cpu and memory. For the random placement strategy, this
	// field is not used.
	Field *string `locationName:"field" type:"string"`

	// The type of placement strategy. The random placement strategy randomly places
	// tasks on available candidates. The spread placement strategy spreads placement
	// across available candidates evenly based on the field parameter. The binpack
	// strategy places tasks on available candidates that have the least available
	// amount of the resource that is specified with the field parameter. For example,
	// if you binpack on memory, a task is placed on the instance with the least
	// amount of remaining memory (but still enough to run the task).
	Type *string `locationName:"type" type:"string" enum:"PlacementStrategyType"`
	// contains filtered or unexported fields
}

The task placement strategy for a task or service. To learn more, see Task Placement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Service Developer Guide.

func (PlacementStrategy) GoString added in v1.38.66 

func (s PlacementStrategy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PlacementStrategy) SetField added in v1.38.66 

func (s *PlacementStrategy) SetField(v string) *PlacementStrategy

SetField sets the Field field's value.

func (*PlacementStrategy) SetType added in v1.38.66 

func (s *PlacementStrategy) SetType(v string) *PlacementStrategy

SetType sets the Type field's value.

func (PlacementStrategy) String added in v1.38.66 

func (s PlacementStrategy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PolicyLengthExceededException added in v1.28.0 

type PolicyLengthExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The event bus policy is too long. For more information, see the limits.

func (*PolicyLengthExceededException) Code added in v1.28.0 

func (s *PolicyLengthExceededException) Code() string

Code returns the exception type name.

func (*PolicyLengthExceededException) Error added in v1.28.0 

func (s *PolicyLengthExceededException) Error() string

func (PolicyLengthExceededException) GoString added in v1.28.0 

func (s PolicyLengthExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PolicyLengthExceededException) Message added in v1.28.0 

func (s *PolicyLengthExceededException) Message() string

Message returns the exception's message.

func (*PolicyLengthExceededException) OrigErr added in v1.28.0 

func (s *PolicyLengthExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PolicyLengthExceededException) RequestID added in v1.28.0 

func (s *PolicyLengthExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PolicyLengthExceededException) StatusCode added in v1.28.0 

func (s *PolicyLengthExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PolicyLengthExceededException) String added in v1.28.0 

func (s PolicyLengthExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutEventsInput 

type PutEventsInput struct {

	// The entry that defines an event in your system. You can specify several parameters
	// for the entry such as the source and type of the event, resources associated
	// with the event, and so on.
	//
	// Entries is a required field
	Entries []*PutEventsRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutEventsInput) GoString 

func (s PutEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsInput) SetEntries added in v1.5.0 

func (s *PutEventsInput) SetEntries(v []*PutEventsRequestEntry) *PutEventsInput

SetEntries sets the Entries field's value.

func (PutEventsInput) String 

func (s PutEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsInput) Validate added in v1.1.21 

func (s *PutEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEventsOutput 

type PutEventsOutput struct {

	// The successfully and unsuccessfully ingested events results. If the ingestion
	// was successful, the entry has the event ID in it. Otherwise, you can use
	// the error code and error message to identify the problem with the entry.
	Entries []*PutEventsResultEntry `type:"list"`

	// The number of failed entries.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (PutEventsOutput) GoString 

func (s PutEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsOutput) SetEntries added in v1.5.0 

func (s *PutEventsOutput) SetEntries(v []*PutEventsResultEntry) *PutEventsOutput

SetEntries sets the Entries field's value.

func (*PutEventsOutput) SetFailedEntryCount added in v1.5.0 

func (s *PutEventsOutput) SetFailedEntryCount(v int64) *PutEventsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (PutEventsOutput) String 

func (s PutEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 name or ARN of the event bus to receive the event. Only the rules that
	// are associated with this event bus are used to match the event. If you omit
	// this, the default event bus is used.
	EventBusName *string `min:"1" type:"string"`

	// Amazon Web Services 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html)
	// call is used.
	Time *time.Time `type:"timestamp"`

	// An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains
	// the trace-id associated with the event.
	//
	// To learn more about X-Ray trace headers, see Tracing header (https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader)
	// in the X-Ray Developer Guide.
	TraceHeader *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents an event to be submitted.

func (PutEventsRequestEntry) GoString 

func (s PutEventsRequestEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsRequestEntry) SetDetail added in v1.5.0 

func (s *PutEventsRequestEntry) SetDetail(v string) *PutEventsRequestEntry

SetDetail sets the Detail field's value.

func (*PutEventsRequestEntry) SetDetailType added in v1.5.0 

func (s *PutEventsRequestEntry) SetDetailType(v string) *PutEventsRequestEntry

SetDetailType sets the DetailType field's value.

func (*PutEventsRequestEntry) SetEventBusName added in v1.20.19 

func (s *PutEventsRequestEntry) SetEventBusName(v string) *PutEventsRequestEntry

SetEventBusName sets the EventBusName field's value.

func (*PutEventsRequestEntry) SetResources added in v1.5.0 

func (s *PutEventsRequestEntry) SetResources(v []*string) *PutEventsRequestEntry

SetResources sets the Resources field's value.

func (*PutEventsRequestEntry) SetSource added in v1.5.0 

func (s *PutEventsRequestEntry) SetSource(v string) *PutEventsRequestEntry

SetSource sets the Source field's value.

func (*PutEventsRequestEntry) SetTime added in v1.5.0 

func (s *PutEventsRequestEntry) SetTime(v time.Time) *PutEventsRequestEntry

SetTime sets the Time field's value.

func (*PutEventsRequestEntry) SetTraceHeader added in v1.37.23 

func (s *PutEventsRequestEntry) SetTraceHeader(v string) *PutEventsRequestEntry

SetTraceHeader sets the TraceHeader field's value.

func (PutEventsRequestEntry) String 

func (s PutEventsRequestEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsRequestEntry) Validate added in v1.20.19 

func (s *PutEventsRequestEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutEventsResultEntry 

type PutEventsResultEntry struct {

	// The error code that indicates why the event submission failed.
	ErrorCode *string `type:"string"`

	// The error message that explains why the event submission failed.
	ErrorMessage *string `type:"string"`

	// The ID of the event.
	EventId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents an event that failed to be submitted.

func (PutEventsResultEntry) GoString 

func (s PutEventsResultEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutEventsResultEntry) SetErrorCode added in v1.5.0 

func (s *PutEventsResultEntry) SetErrorCode(v string) *PutEventsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutEventsResultEntry) SetErrorMessage added in v1.5.0 

func (s *PutEventsResultEntry) SetErrorMessage(v string) *PutEventsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutEventsResultEntry) SetEventId added in v1.5.0 

func (s *PutEventsResultEntry) SetEventId(v string) *PutEventsResultEntry

SetEventId sets the EventId field's value.

func (PutEventsResultEntry) String 

func (s PutEventsResultEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutPartnerEventsInput added in v1.20.19 

type PutPartnerEventsInput struct {

	// The list of events to write to the event bus.
	//
	// Entries is a required field
	Entries []*PutPartnerEventsRequestEntry `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutPartnerEventsInput) GoString added in v1.20.19 

func (s PutPartnerEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPartnerEventsInput) SetEntries added in v1.20.19 

func (s *PutPartnerEventsInput) SetEntries(v []*PutPartnerEventsRequestEntry) *PutPartnerEventsInput

SetEntries sets the Entries field's value.

func (PutPartnerEventsInput) String added in v1.20.19 

func (s PutPartnerEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPartnerEventsInput) Validate added in v1.20.19 

func (s *PutPartnerEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPartnerEventsOutput added in v1.20.19 

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) GoString added in v1.20.19 

func (s PutPartnerEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPartnerEventsOutput) SetEntries added in v1.20.19 

func (s *PutPartnerEventsOutput) SetEntries(v []*PutPartnerEventsResultEntry) *PutPartnerEventsOutput

SetEntries sets the Entries field's value.

func (*PutPartnerEventsOutput) SetFailedEntryCount added in v1.20.19 

func (s *PutPartnerEventsOutput) SetFailedEntryCount(v int64) *PutPartnerEventsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (PutPartnerEventsOutput) String added in v1.20.19 

func (s PutPartnerEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutPartnerEventsRequestEntry added in v1.20.19 

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"`

	// Amazon Web Services 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 entry.
	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) GoString added in v1.20.19 

func (s PutPartnerEventsRequestEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPartnerEventsRequestEntry) SetDetail added in v1.20.19 

func (s *PutPartnerEventsRequestEntry) SetDetail(v string) *PutPartnerEventsRequestEntry

SetDetail sets the Detail field's value.

func (*PutPartnerEventsRequestEntry) SetDetailType added in v1.20.19 

func (s *PutPartnerEventsRequestEntry) SetDetailType(v string) *PutPartnerEventsRequestEntry

SetDetailType sets the DetailType field's value.

func (*PutPartnerEventsRequestEntry) SetResources added in v1.20.19 

func (s *PutPartnerEventsRequestEntry) SetResources(v []*string) *PutPartnerEventsRequestEntry

SetResources sets the Resources field's value.

func (*PutPartnerEventsRequestEntry) SetSource added in v1.20.19 

func (s *PutPartnerEventsRequestEntry) SetSource(v string) *PutPartnerEventsRequestEntry

SetSource sets the Source field's value.

func (*PutPartnerEventsRequestEntry) SetTime added in v1.20.19 

func (s *PutPartnerEventsRequestEntry) SetTime(v time.Time) *PutPartnerEventsRequestEntry

SetTime sets the Time field's value.

func (PutPartnerEventsRequestEntry) String added in v1.20.19 

func (s PutPartnerEventsRequestEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPartnerEventsRequestEntry) Validate added in v1.29.9 

func (s *PutPartnerEventsRequestEntry) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPartnerEventsResultEntry added in v1.20.19 

type PutPartnerEventsResultEntry struct {

	// The error code that indicates why the event submission failed.
	ErrorCode *string `type:"string"`

	// The error message that explains why the event submission failed.
	ErrorMessage *string `type:"string"`

	// The ID of the event.
	EventId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents an event that a partner tried to generate, but failed.

func (PutPartnerEventsResultEntry) GoString added in v1.20.19 

func (s PutPartnerEventsResultEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPartnerEventsResultEntry) SetErrorCode added in v1.20.19 

func (s *PutPartnerEventsResultEntry) SetErrorCode(v string) *PutPartnerEventsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutPartnerEventsResultEntry) SetErrorMessage added in v1.20.19 

func (s *PutPartnerEventsResultEntry) SetErrorMessage(v string) *PutPartnerEventsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutPartnerEventsResultEntry) SetEventId added in v1.20.19 

func (s *PutPartnerEventsResultEntry) SetEventId(v string) *PutPartnerEventsResultEntry

SetEventId sets the EventId field's value.

func (PutPartnerEventsResultEntry) String added in v1.20.19 

func (s PutPartnerEventsResultEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutPermissionInput added in v1.10.5 

type PutPermissionInput struct {

	// The action that you are enabling the other account to perform.
	Action *string `min:"1" type:"string"`

	// This parameter enables you to limit the permission to accounts that fulfill
	// a certain condition, such as being a member of a certain Amazon Web Services
	// organization. For more information about Amazon Web Services Organizations,
	// see What Is Amazon Web Services Organizations (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html)
	// in the Amazon Web Services Organizations User Guide.
	//
	// If you specify Condition with an Amazon Web Services 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 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"`

	// A JSON string that describes the permission policy statement. You can include
	// a Policy parameter in the request instead of using the StatementId, Action,
	// Principal, or Condition parameters.
	Policy *string `type:"string"`

	// The 12-digit Amazon Web Services 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 *string `min:"1" type:"string"`

	// 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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html).
	StatementId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutPermissionInput) GoString added in v1.10.5 

func (s PutPermissionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPermissionInput) SetAction added in v1.10.5 

func (s *PutPermissionInput) SetAction(v string) *PutPermissionInput

SetAction sets the Action field's value.

func (*PutPermissionInput) SetCondition added in v1.15.57 

func (s *PutPermissionInput) SetCondition(v *Condition) *PutPermissionInput

SetCondition sets the Condition field's value.

func (*PutPermissionInput) SetEventBusName added in v1.20.19 

func (s *PutPermissionInput) SetEventBusName(v string) *PutPermissionInput

SetEventBusName sets the EventBusName field's value.

func (*PutPermissionInput) SetPolicy added in v1.35.32 

func (s *PutPermissionInput) SetPolicy(v string) *PutPermissionInput

SetPolicy sets the Policy field's value.

func (*PutPermissionInput) SetPrincipal added in v1.10.5 

func (s *PutPermissionInput) SetPrincipal(v string) *PutPermissionInput

SetPrincipal sets the Principal field's value.

func (*PutPermissionInput) SetStatementId added in v1.10.5 

func (s *PutPermissionInput) SetStatementId(v string) *PutPermissionInput

SetStatementId sets the StatementId field's value.

func (PutPermissionInput) String added in v1.10.5 

func (s PutPermissionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutPermissionInput) Validate added in v1.10.5 

func (s *PutPermissionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutPermissionOutput added in v1.10.5 

type PutPermissionOutput struct {
	// contains filtered or unexported fields
}

func (PutPermissionOutput) GoString added in v1.10.5 

func (s PutPermissionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutPermissionOutput) String added in v1.10.5 

func (s PutPermissionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutRuleInput 

type PutRuleInput struct {

	// A description of the rule.
	Description *string `type:"string"`

	// The name or ARN of 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.
	//
	// If you're setting an event bus in another account as the target and that
	// account granted permission to your account through an organization instead
	// of directly by the account ID, you must specify a RoleArn with proper permissions
	// in the Target structure, instead of here in this parameter.
	RoleArn *string `min:"1" type:"string"`

	// The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
	ScheduleExpression *string `type:"string"`

	// Indicates whether the rule is enabled or disabled.
	State *string `type:"string" enum:"RuleState"`

	// The list of key-value pairs to associate with the rule.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (PutRuleInput) GoString 

func (s PutRuleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRuleInput) SetDescription added in v1.5.0 

func (s *PutRuleInput) SetDescription(v string) *PutRuleInput

SetDescription sets the Description field's value.

func (*PutRuleInput) SetEventBusName added in v1.20.19 

func (s *PutRuleInput) SetEventBusName(v string) *PutRuleInput

SetEventBusName sets the EventBusName field's value.

func (*PutRuleInput) SetEventPattern added in v1.5.0 

func (s *PutRuleInput) SetEventPattern(v string) *PutRuleInput

SetEventPattern sets the EventPattern field's value.

func (*PutRuleInput) SetName added in v1.5.0 

func (s *PutRuleInput) SetName(v string) *PutRuleInput

SetName sets the Name field's value.

func (*PutRuleInput) SetRoleArn added in v1.5.0 

func (s *PutRuleInput) SetRoleArn(v string) *PutRuleInput

SetRoleArn sets the RoleArn field's value.

func (*PutRuleInput) SetScheduleExpression added in v1.5.0 

func (s *PutRuleInput) SetScheduleExpression(v string) *PutRuleInput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*PutRuleInput) SetState added in v1.5.0 

func (s *PutRuleInput) SetState(v string) *PutRuleInput

SetState sets the State field's value.

func (*PutRuleInput) SetTags added in v1.19.0 

func (s *PutRuleInput) SetTags(v []*Tag) *PutRuleInput

SetTags sets the Tags field's value.

func (PutRuleInput) String 

func (s PutRuleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRuleInput) Validate added in v1.1.21 

func (s *PutRuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutRuleOutput 

type PutRuleOutput struct {

	// The Amazon Resource Name (ARN) of the rule.
	RuleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutRuleOutput) GoString 

func (s PutRuleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRuleOutput) SetRuleArn added in v1.5.0 

func (s *PutRuleOutput) SetRuleArn(v string) *PutRuleOutput

SetRuleArn sets the RuleArn field's value.

func (PutRuleOutput) String 

func (s PutRuleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutTargetsInput 

type PutTargetsInput struct {

	// The name or ARN of the event bus associated with the rule. If you omit this,
	// the default event bus is used.
	EventBusName *string `min:"1" type:"string"`

	// The name of the rule.
	//
	// Rule is a required field
	Rule *string `min:"1" type:"string" required:"true"`

	// The targets to update or add to the rule.
	//
	// Targets is a required field
	Targets []*Target `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (PutTargetsInput) GoString 

func (s PutTargetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutTargetsInput) SetEventBusName added in v1.20.19 

func (s *PutTargetsInput) SetEventBusName(v string) *PutTargetsInput

SetEventBusName sets the EventBusName field's value.

func (*PutTargetsInput) SetRule added in v1.5.0 

func (s *PutTargetsInput) SetRule(v string) *PutTargetsInput

SetRule sets the Rule field's value.

func (*PutTargetsInput) SetTargets added in v1.5.0 

func (s *PutTargetsInput) SetTargets(v []*Target) *PutTargetsInput

SetTargets sets the Targets field's value.

func (PutTargetsInput) String 

func (s PutTargetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutTargetsInput) Validate added in v1.1.21 

func (s *PutTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutTargetsOutput 

type PutTargetsOutput struct {

	// The failed target entries.
	FailedEntries []*PutTargetsResultEntry `type:"list"`

	// The number of failed entries.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (PutTargetsOutput) GoString 

func (s PutTargetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutTargetsOutput) SetFailedEntries added in v1.5.0 

func (s *PutTargetsOutput) SetFailedEntries(v []*PutTargetsResultEntry) *PutTargetsOutput

SetFailedEntries sets the FailedEntries field's value.

func (*PutTargetsOutput) SetFailedEntryCount added in v1.5.0 

func (s *PutTargetsOutput) SetFailedEntryCount(v int64) *PutTargetsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (PutTargetsOutput) String 

func (s PutTargetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutTargetsResultEntry 

type PutTargetsResultEntry struct {

	// The error code that indicates why the target addition failed. If the value
	// is ConcurrentModificationException, too many requests were made at the same
	// time.
	ErrorCode *string `type:"string"`

	// The error message that explains why the target addition failed.
	ErrorMessage *string `type:"string"`

	// The ID of the target.
	TargetId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a target that failed to be added to a rule.

func (PutTargetsResultEntry) GoString 

func (s PutTargetsResultEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutTargetsResultEntry) SetErrorCode added in v1.5.0 

func (s *PutTargetsResultEntry) SetErrorCode(v string) *PutTargetsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*PutTargetsResultEntry) SetErrorMessage added in v1.5.0 

func (s *PutTargetsResultEntry) SetErrorMessage(v string) *PutTargetsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*PutTargetsResultEntry) SetTargetId added in v1.5.0 

func (s *PutTargetsResultEntry) SetTargetId(v string) *PutTargetsResultEntry

SetTargetId sets the TargetId field's value.

func (PutTargetsResultEntry) String 

func (s PutTargetsResultEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RedshiftDataParameters added in v1.34.28 

type RedshiftDataParameters struct {

	// The name of the database. Required when authenticating using temporary credentials.
	//
	// Database is a required field
	Database *string `min:"1" type:"string" required:"true"`

	// The database user name. Required when authenticating using temporary credentials.
	DbUser *string `min:"1" type:"string"`

	// The name or ARN of the secret that enables access to the database. Required
	// when authenticating using Amazon Web Services Secrets Manager.
	SecretManagerArn *string `min:"1" type:"string"`

	// The SQL statement text to run.
	//
	// Sql is a required field
	Sql *string `min:"1" type:"string" required:"true"`

	// The name of the SQL statement. You can name the SQL statement when you create
	// it to identify the query.
	StatementName *string `min:"1" type:"string"`

	// Indicates whether to send an event back to EventBridge after the SQL statement
	// runs.
	WithEvent *bool `type:"boolean"`
	// contains filtered or unexported fields
}

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

func (RedshiftDataParameters) GoString added in v1.34.28 

func (s RedshiftDataParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedshiftDataParameters) SetDatabase added in v1.34.28 

func (s *RedshiftDataParameters) SetDatabase(v string) *RedshiftDataParameters

SetDatabase sets the Database field's value.

func (*RedshiftDataParameters) SetDbUser added in v1.34.28 

func (s *RedshiftDataParameters) SetDbUser(v string) *RedshiftDataParameters

SetDbUser sets the DbUser field's value.

func (*RedshiftDataParameters) SetSecretManagerArn added in v1.34.28 

func (s *RedshiftDataParameters) SetSecretManagerArn(v string) *RedshiftDataParameters

SetSecretManagerArn sets the SecretManagerArn field's value.

func (*RedshiftDataParameters) SetSql added in v1.34.28 

func (s *RedshiftDataParameters) SetSql(v string) *RedshiftDataParameters

SetSql sets the Sql field's value.

func (*RedshiftDataParameters) SetStatementName added in v1.34.28 

func (s *RedshiftDataParameters) SetStatementName(v string) *RedshiftDataParameters

SetStatementName sets the StatementName field's value.

func (*RedshiftDataParameters) SetWithEvent added in v1.34.28 

func (s *RedshiftDataParameters) SetWithEvent(v bool) *RedshiftDataParameters

SetWithEvent sets the WithEvent field's value.

func (RedshiftDataParameters) String added in v1.34.28 

func (s RedshiftDataParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedshiftDataParameters) Validate added in v1.34.28 

func (s *RedshiftDataParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemovePermissionInput added in v1.10.5 

type RemovePermissionInput struct {

	// The name of the event bus to revoke permissions for. If you omit this, the
	// default event bus is used.
	EventBusName *string `min:"1" type:"string"`

	// Specifies whether to remove all permissions.
	RemoveAllPermissions *bool `type:"boolean"`

	// The statement ID corresponding to the account that is no longer allowed to
	// put events to the default event bus.
	StatementId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (RemovePermissionInput) GoString added in v1.10.5 

func (s RemovePermissionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemovePermissionInput) SetEventBusName added in v1.20.19 

func (s *RemovePermissionInput) SetEventBusName(v string) *RemovePermissionInput

SetEventBusName sets the EventBusName field's value.

func (*RemovePermissionInput) SetRemoveAllPermissions added in v1.35.32 

func (s *RemovePermissionInput) SetRemoveAllPermissions(v bool) *RemovePermissionInput

SetRemoveAllPermissions sets the RemoveAllPermissions field's value.

func (*RemovePermissionInput) SetStatementId added in v1.10.5 

func (s *RemovePermissionInput) SetStatementId(v string) *RemovePermissionInput

SetStatementId sets the StatementId field's value.

func (RemovePermissionInput) String added in v1.10.5 

func (s RemovePermissionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemovePermissionInput) Validate added in v1.10.5 

func (s *RemovePermissionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemovePermissionOutput added in v1.10.5 

type RemovePermissionOutput struct {
	// contains filtered or unexported fields
}

func (RemovePermissionOutput) GoString added in v1.10.5 

func (s RemovePermissionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RemovePermissionOutput) String added in v1.10.5 

func (s RemovePermissionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveTargetsInput 

type RemoveTargetsInput struct {

	// The name or ARN of 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 Amazon Web Services 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) GoString 

func (s RemoveTargetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTargetsInput) SetEventBusName added in v1.20.19 

func (s *RemoveTargetsInput) SetEventBusName(v string) *RemoveTargetsInput

SetEventBusName sets the EventBusName field's value.

func (*RemoveTargetsInput) SetForce added in v1.15.87 

func (s *RemoveTargetsInput) SetForce(v bool) *RemoveTargetsInput

SetForce sets the Force field's value.

func (*RemoveTargetsInput) SetIds added in v1.5.0 

func (s *RemoveTargetsInput) SetIds(v []*string) *RemoveTargetsInput

SetIds sets the Ids field's value.

func (*RemoveTargetsInput) SetRule added in v1.5.0 

func (s *RemoveTargetsInput) SetRule(v string) *RemoveTargetsInput

SetRule sets the Rule field's value.

func (RemoveTargetsInput) String 

func (s RemoveTargetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTargetsInput) Validate added in v1.1.21 

func (s *RemoveTargetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveTargetsOutput 

type RemoveTargetsOutput struct {

	// The failed target entries.
	FailedEntries []*RemoveTargetsResultEntry `type:"list"`

	// The number of failed entries.
	FailedEntryCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (RemoveTargetsOutput) GoString 

func (s RemoveTargetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTargetsOutput) SetFailedEntries added in v1.5.0 

func (s *RemoveTargetsOutput) SetFailedEntries(v []*RemoveTargetsResultEntry) *RemoveTargetsOutput

SetFailedEntries sets the FailedEntries field's value.

func (*RemoveTargetsOutput) SetFailedEntryCount added in v1.5.0 

func (s *RemoveTargetsOutput) SetFailedEntryCount(v int64) *RemoveTargetsOutput

SetFailedEntryCount sets the FailedEntryCount field's value.

func (RemoveTargetsOutput) String 

func (s RemoveTargetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RemoveTargetsResultEntry 

type RemoveTargetsResultEntry struct {

	// The error code that indicates why the target removal failed. If the value
	// is ConcurrentModificationException, too many requests were made at the same
	// time.
	ErrorCode *string `type:"string"`

	// The error message that explains why the target removal failed.
	ErrorMessage *string `type:"string"`

	// The ID of the target.
	TargetId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a target that failed to be removed from a rule.

func (RemoveTargetsResultEntry) GoString 

func (s RemoveTargetsResultEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RemoveTargetsResultEntry) SetErrorCode added in v1.5.0 

func (s *RemoveTargetsResultEntry) SetErrorCode(v string) *RemoveTargetsResultEntry

SetErrorCode sets the ErrorCode field's value.

func (*RemoveTargetsResultEntry) SetErrorMessage added in v1.5.0 

func (s *RemoveTargetsResultEntry) SetErrorMessage(v string) *RemoveTargetsResultEntry

SetErrorMessage sets the ErrorMessage field's value.

func (*RemoveTargetsResultEntry) SetTargetId added in v1.5.0 

func (s *RemoveTargetsResultEntry) SetTargetId(v string) *RemoveTargetsResultEntry

SetTargetId sets the TargetId field's value.

func (RemoveTargetsResultEntry) String 

func (s RemoveTargetsResultEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Replay added in v1.35.22 

type Replay struct {

	// A time stamp for the time to start replaying events. Any event with a creation
	// time prior to the EventEndTime specified is replayed.
	EventEndTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the last event was replayed.
	EventLastReplayedTime *time.Time `type:"timestamp"`

	// The ARN of the archive to replay event from.
	EventSourceArn *string `min:"1" type:"string"`

	// A time stamp for the time to start replaying events. This is determined by
	// the time in the event as described in Time (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEventsRequestEntry.html#eventbridge-Type-PutEventsRequestEntry-Time).
	EventStartTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the replay completed.
	ReplayEndTime *time.Time `type:"timestamp"`

	// The name of the replay.
	ReplayName *string `min:"1" type:"string"`

	// A time stamp for the time that the replay started.
	ReplayStartTime *time.Time `type:"timestamp"`

	// The current state of the replay.
	State *string `type:"string" enum:"ReplayState"`

	// A description of why the replay is in the current state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

A Replay object that contains details about a replay.

func (Replay) GoString added in v1.35.22 

func (s Replay) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Replay) SetEventEndTime added in v1.35.22 

func (s *Replay) SetEventEndTime(v time.Time) *Replay

SetEventEndTime sets the EventEndTime field's value.

func (*Replay) SetEventLastReplayedTime added in v1.35.22 

func (s *Replay) SetEventLastReplayedTime(v time.Time) *Replay

SetEventLastReplayedTime sets the EventLastReplayedTime field's value.

func (*Replay) SetEventSourceArn added in v1.35.22 

func (s *Replay) SetEventSourceArn(v string) *Replay

SetEventSourceArn sets the EventSourceArn field's value.

func (*Replay) SetEventStartTime added in v1.35.22 

func (s *Replay) SetEventStartTime(v time.Time) *Replay

SetEventStartTime sets the EventStartTime field's value.

func (*Replay) SetReplayEndTime added in v1.35.22 

func (s *Replay) SetReplayEndTime(v time.Time) *Replay

SetReplayEndTime sets the ReplayEndTime field's value.

func (*Replay) SetReplayName added in v1.35.22 

func (s *Replay) SetReplayName(v string) *Replay

SetReplayName sets the ReplayName field's value.

func (*Replay) SetReplayStartTime added in v1.35.22 

func (s *Replay) SetReplayStartTime(v time.Time) *Replay

SetReplayStartTime sets the ReplayStartTime field's value.

func (*Replay) SetState added in v1.35.22 

func (s *Replay) SetState(v string) *Replay

SetState sets the State field's value.

func (*Replay) SetStateReason added in v1.35.22 

func (s *Replay) SetStateReason(v string) *Replay

SetStateReason sets the StateReason field's value.

func (Replay) String added in v1.35.22 

func (s Replay) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplayDestination added in v1.35.22 

type ReplayDestination struct {

	// The ARN of the event bus to replay event to. You can replay events only to
	// the event bus specified to create the archive.
	//
	// Arn is a required field
	Arn *string `min:"1" type:"string" required:"true"`

	// A list of ARNs for rules to replay events to.
	FilterArns []*string `type:"list"`
	// contains filtered or unexported fields
}

A ReplayDestination object that contains details about a replay.

func (ReplayDestination) GoString added in v1.35.22 

func (s ReplayDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplayDestination) SetArn added in v1.35.22 

func (s *ReplayDestination) SetArn(v string) *ReplayDestination

SetArn sets the Arn field's value.

func (*ReplayDestination) SetFilterArns added in v1.35.22 

func (s *ReplayDestination) SetFilterArns(v []*string) *ReplayDestination

SetFilterArns sets the FilterArns field's value.

func (ReplayDestination) String added in v1.35.22 

func (s ReplayDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplayDestination) Validate added in v1.35.22 

func (s *ReplayDestination) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceAlreadyExistsException added in v1.28.0 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource you are trying to create already exists.

func (*ResourceAlreadyExistsException) Code added in v1.28.0 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString added in v1.28.0 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message added in v1.28.0 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.28.0 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An entity that you specified does not exist.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetryPolicy added in v1.35.6 

type RetryPolicy struct {

	// The maximum amount of time, in seconds, to continue to make retry attempts.
	MaximumEventAgeInSeconds *int64 `min:"60" type:"integer"`

	// The maximum number of retry attempts to make before the request fails. Retry
	// attempts continue until either the maximum number of attempts is made or
	// until the duration of the MaximumEventAgeInSeconds is met.
	MaximumRetryAttempts *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A RetryPolicy object that includes information about the retry policy settings.

func (RetryPolicy) GoString added in v1.35.6 

func (s RetryPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetryPolicy) SetMaximumEventAgeInSeconds added in v1.35.6 

func (s *RetryPolicy) SetMaximumEventAgeInSeconds(v int64) *RetryPolicy

SetMaximumEventAgeInSeconds sets the MaximumEventAgeInSeconds field's value.

func (*RetryPolicy) SetMaximumRetryAttempts added in v1.35.6 

func (s *RetryPolicy) SetMaximumRetryAttempts(v int64) *RetryPolicy

SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value.

func (RetryPolicy) String added in v1.35.6 

func (s RetryPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetryPolicy) Validate added in v1.35.6 

func (s *RetryPolicy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 name or ARN 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 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 Amazon Web Services
	// 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.
	//
	// If you're setting an event bus in another account as the target and that
	// account granted permission to your account through an organization instead
	// of directly by the account ID, you must specify a RoleArn with proper permissions
	// in the Target structure, instead of here in this parameter.
	RoleArn *string `min:"1" type:"string"`

	// The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
	// For more information, see Creating an Amazon EventBridge rule that runs on
	// a schedule (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html).
	ScheduleExpression *string `type:"string"`

	// The state of the rule.
	State *string `type:"string" enum:"RuleState"`
	// contains filtered or unexported fields
}

Contains information about a rule in Amazon EventBridge.

func (Rule) GoString 

func (s Rule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Rule) SetArn added in v1.5.0 

func (s *Rule) SetArn(v string) *Rule

SetArn sets the Arn field's value.

func (*Rule) SetDescription added in v1.5.0 

func (s *Rule) SetDescription(v string) *Rule

SetDescription sets the Description field's value.

func (*Rule) SetEventBusName added in v1.20.19 

func (s *Rule) SetEventBusName(v string) *Rule

SetEventBusName sets the EventBusName field's value.

func (*Rule) SetEventPattern added in v1.5.0 

func (s *Rule) SetEventPattern(v string) *Rule

SetEventPattern sets the EventPattern field's value.

func (*Rule) SetManagedBy added in v1.15.87 

func (s *Rule) SetManagedBy(v string) *Rule

SetManagedBy sets the ManagedBy field's value.

func (*Rule) SetName added in v1.5.0 

func (s *Rule) SetName(v string) *Rule

SetName sets the Name field's value.

func (*Rule) SetRoleArn added in v1.5.0 

func (s *Rule) SetRoleArn(v string) *Rule

SetRoleArn sets the RoleArn field's value.

func (*Rule) SetScheduleExpression added in v1.5.0 

func (s *Rule) SetScheduleExpression(v string) *Rule

SetScheduleExpression sets the ScheduleExpression field's value.

func (*Rule) SetState added in v1.5.0 

func (s *Rule) SetState(v string) *Rule

SetState sets the State field's value.

func (Rule) String 

func (s Rule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RunCommandParameters added in v1.7.9 

type RunCommandParameters struct {

	// Currently, we support including only one RunCommandTarget block, which specifies
	// either an array of InstanceIds or a tag.
	//
	// RunCommandTargets is a required field
	RunCommandTargets []*RunCommandTarget `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

func (RunCommandParameters) GoString added in v1.7.9 

func (s RunCommandParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RunCommandParameters) SetRunCommandTargets added in v1.7.9 

func (s *RunCommandParameters) SetRunCommandTargets(v []*RunCommandTarget) *RunCommandParameters

SetRunCommandTargets sets the RunCommandTargets field's value.

func (RunCommandParameters) String added in v1.7.9 

func (s RunCommandParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RunCommandParameters) Validate added in v1.7.9 

func (s *RunCommandParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RunCommandTarget added in v1.7.9 

type RunCommandTarget struct {

	// Can be either tag: tag-key or InstanceIds.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds,
	// Values is a list of Amazon EC2 instance IDs.
	//
	// Values is a required field
	Values []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.

func (RunCommandTarget) GoString added in v1.7.9 

func (s RunCommandTarget) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RunCommandTarget) SetKey added in v1.7.9 

func (s *RunCommandTarget) SetKey(v string) *RunCommandTarget

SetKey sets the Key field's value.

func (*RunCommandTarget) SetValues added in v1.7.9 

func (s *RunCommandTarget) SetValues(v []*string) *RunCommandTarget

SetValues sets the Values field's value.

func (RunCommandTarget) String added in v1.7.9 

func (s RunCommandTarget) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RunCommandTarget) Validate added in v1.7.9 

func (s *RunCommandTarget) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SageMakerPipelineParameter added in v1.38.7 

type SageMakerPipelineParameter struct {

	// Name of parameter to start execution of a SageMaker Model Building Pipeline.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Value of parameter to start execution of a SageMaker Model Building Pipeline.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.

func (SageMakerPipelineParameter) GoString added in v1.38.7 

func (s SageMakerPipelineParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SageMakerPipelineParameter) SetName added in v1.38.7 

func (s *SageMakerPipelineParameter) SetName(v string) *SageMakerPipelineParameter

SetName sets the Name field's value.

func (*SageMakerPipelineParameter) SetValue added in v1.38.7 

func (s *SageMakerPipelineParameter) SetValue(v string) *SageMakerPipelineParameter

SetValue sets the Value field's value.

func (SageMakerPipelineParameter) String added in v1.38.7 

func (s SageMakerPipelineParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SageMakerPipelineParameter) Validate added in v1.38.7 

func (s *SageMakerPipelineParameter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SageMakerPipelineParameters added in v1.38.7 

type SageMakerPipelineParameters struct {

	// List of Parameter names and values for SageMaker Model Building Pipeline
	// execution.
	PipelineParameterList []*SageMakerPipelineParameter `type:"list"`
	// contains filtered or unexported fields
}

These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on EventBridge events.

func (SageMakerPipelineParameters) GoString added in v1.38.7 

func (s SageMakerPipelineParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SageMakerPipelineParameters) SetPipelineParameterList added in v1.38.7 

func (s *SageMakerPipelineParameters) SetPipelineParameterList(v []*SageMakerPipelineParameter) *SageMakerPipelineParameters

SetPipelineParameterList sets the PipelineParameterList field's value.

func (SageMakerPipelineParameters) String added in v1.38.7 

func (s SageMakerPipelineParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SageMakerPipelineParameters) Validate added in v1.38.7 

func (s *SageMakerPipelineParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SqsParameters added in v1.13.17 

type SqsParameters struct {

	// The FIFO message group ID to use as the target.
	MessageGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

This structure includes the custom parameter to be used when the target is an SQS FIFO queue.

func (SqsParameters) GoString added in v1.13.17 

func (s SqsParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SqsParameters) SetMessageGroupId added in v1.13.17 

func (s *SqsParameters) SetMessageGroupId(v string) *SqsParameters

SetMessageGroupId sets the MessageGroupId field's value.

func (SqsParameters) String added in v1.13.17 

func (s SqsParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartReplayInput added in v1.35.22 

type StartReplayInput struct {

	// A description for the replay to start.
	Description *string `type:"string"`

	// A ReplayDestination object that includes details about the destination for
	// the replay.
	//
	// Destination is a required field
	Destination *ReplayDestination `type:"structure" required:"true"`

	// A time stamp for the time to stop replaying events. Only events that occurred
	// between the EventStartTime and EventEndTime are replayed.
	//
	// EventEndTime is a required field
	EventEndTime *time.Time `type:"timestamp" required:"true"`

	// The ARN of the archive to replay events from.
	//
	// EventSourceArn is a required field
	EventSourceArn *string `min:"1" type:"string" required:"true"`

	// A time stamp for the time to start replaying events. Only events that occurred
	// between the EventStartTime and EventEndTime are replayed.
	//
	// EventStartTime is a required field
	EventStartTime *time.Time `type:"timestamp" required:"true"`

	// The name of the replay to start.
	//
	// ReplayName is a required field
	ReplayName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartReplayInput) GoString added in v1.35.22 

func (s StartReplayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReplayInput) SetDescription added in v1.35.22 

func (s *StartReplayInput) SetDescription(v string) *StartReplayInput

SetDescription sets the Description field's value.

func (*StartReplayInput) SetDestination added in v1.35.22 

func (s *StartReplayInput) SetDestination(v *ReplayDestination) *StartReplayInput

SetDestination sets the Destination field's value.

func (*StartReplayInput) SetEventEndTime added in v1.35.22 

func (s *StartReplayInput) SetEventEndTime(v time.Time) *StartReplayInput

SetEventEndTime sets the EventEndTime field's value.

func (*StartReplayInput) SetEventSourceArn added in v1.35.22 

func (s *StartReplayInput) SetEventSourceArn(v string) *StartReplayInput

SetEventSourceArn sets the EventSourceArn field's value.

func (*StartReplayInput) SetEventStartTime added in v1.35.22 

func (s *StartReplayInput) SetEventStartTime(v time.Time) *StartReplayInput

SetEventStartTime sets the EventStartTime field's value.

func (*StartReplayInput) SetReplayName added in v1.35.22 

func (s *StartReplayInput) SetReplayName(v string) *StartReplayInput

SetReplayName sets the ReplayName field's value.

func (StartReplayInput) String added in v1.35.22 

func (s StartReplayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReplayInput) Validate added in v1.35.22 

func (s *StartReplayInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartReplayOutput added in v1.35.22 

type StartReplayOutput struct {

	// The ARN of the replay.
	ReplayArn *string `min:"1" type:"string"`

	// The time at which the replay started.
	ReplayStartTime *time.Time `type:"timestamp"`

	// The state of the replay.
	State *string `type:"string" enum:"ReplayState"`

	// The reason that the replay is in the state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartReplayOutput) GoString added in v1.35.22 

func (s StartReplayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReplayOutput) SetReplayArn added in v1.35.22 

func (s *StartReplayOutput) SetReplayArn(v string) *StartReplayOutput

SetReplayArn sets the ReplayArn field's value.

func (*StartReplayOutput) SetReplayStartTime added in v1.35.22 

func (s *StartReplayOutput) SetReplayStartTime(v time.Time) *StartReplayOutput

SetReplayStartTime sets the ReplayStartTime field's value.

func (*StartReplayOutput) SetState added in v1.35.22 

func (s *StartReplayOutput) SetState(v string) *StartReplayOutput

SetState sets the State field's value.

func (*StartReplayOutput) SetStateReason added in v1.35.22 

func (s *StartReplayOutput) SetStateReason(v string) *StartReplayOutput

SetStateReason sets the StateReason field's value.

func (StartReplayOutput) String added in v1.35.22 

func (s StartReplayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.19.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 Amazon Web Services resource. In EventBridge, rules and event buses support tagging.

func (Tag) GoString added in v1.19.0 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.19.0 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.19.0 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.19.0 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.19.0 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.19.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) GoString added in v1.19.0 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceARN added in v1.19.0 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.19.0 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.19.0 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.19.0 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.19.0 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.19.0 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.19.0 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 Batch User Guide.
	BatchParameters *BatchParameters `type:"structure"`

	// The DeadLetterConfig that defines the target queue to send dead-letter queue
	// events to.
	DeadLetterConfig *DeadLetterConfig `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 or EventBridge ApiDestination.
	//
	// If you specify an API Gateway REST API or EventBridge ApiDestination as a
	// target, you can use this parameter to specify headers, path parameters, and
	// query string keys/values as part of your target invoking request. If you're
	// using ApiDestinations, the corresponding Connection can also have these values
	// configured. In case of any conflicting keys, values from the Connection take
	// precedence.
	HttpParameters *HttpParameters `type:"structure"`

	// The ID of the target. We recommend using a memorable and unique string.
	//
	// 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"`

	// Contains the Amazon Redshift Data API parameters to use when the target is
	// a Amazon Redshift cluster.
	//
	// If you specify a Amazon Redshift Cluster as a Target, you can use this to
	// specify parameters to invoke the Amazon Redshift Data API ExecuteStatement
	// based on EventBridge events.
	RedshiftDataParameters *RedshiftDataParameters `type:"structure"`

	// The RetryPolicy object that contains the retry policy configuration to use
	// for the dead-letter queue.
	RetryPolicy *RetryPolicy `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 SageMaker Model Building Pipeline parameters to start execution
	// of a SageMaker Model Building Pipeline.
	//
	// If you specify a SageMaker Model Building Pipeline as a target, you can use
	// this to specify parameters to start a pipeline execution based on EventBridge
	// events.
	SageMakerPipelineParameters *SageMakerPipelineParameters `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 (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html).

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 Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the Amazon EventBridge User Guide.

func (Target) GoString 

func (s Target) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Target) SetArn added in v1.5.0 

func (s *Target) SetArn(v string) *Target

SetArn sets the Arn field's value.

func (*Target) SetBatchParameters added in v1.13.8 

func (s *Target) SetBatchParameters(v *BatchParameters) *Target

SetBatchParameters sets the BatchParameters field's value.

func (*Target) SetDeadLetterConfig added in v1.35.6 

func (s *Target) SetDeadLetterConfig(v *DeadLetterConfig) *Target

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*Target) SetEcsParameters added in v1.7.9 

func (s *Target) SetEcsParameters(v *EcsParameters) *Target

SetEcsParameters sets the EcsParameters field's value.

func (*Target) SetHttpParameters added in v1.33.5 

func (s *Target) SetHttpParameters(v *HttpParameters) *Target

SetHttpParameters sets the HttpParameters field's value.

func (*Target) SetId added in v1.5.0 

func (s *Target) SetId(v string) *Target

SetId sets the Id field's value.

func (*Target) SetInput added in v1.5.0 

func (s *Target) SetInput(v string) *Target

SetInput sets the Input field's value.

func (*Target) SetInputPath added in v1.5.0 

func (s *Target) SetInputPath(v string) *Target

SetInputPath sets the InputPath field's value.

func (*Target) SetInputTransformer added in v1.7.9 

func (s *Target) SetInputTransformer(v *InputTransformer) *Target

SetInputTransformer sets the InputTransformer field's value.

func (*Target) SetKinesisParameters added in v1.7.9 

func (s *Target) SetKinesisParameters(v *KinesisParameters) *Target

SetKinesisParameters sets the KinesisParameters field's value.

func (*Target) SetRedshiftDataParameters added in v1.34.28 

func (s *Target) SetRedshiftDataParameters(v *RedshiftDataParameters) *Target

SetRedshiftDataParameters sets the RedshiftDataParameters field's value.

func (*Target) SetRetryPolicy added in v1.35.6 

func (s *Target) SetRetryPolicy(v *RetryPolicy) *Target

SetRetryPolicy sets the RetryPolicy field's value.

func (*Target) SetRoleArn added in v1.7.9 

func (s *Target) SetRoleArn(v string) *Target

SetRoleArn sets the RoleArn field's value.

func (*Target) SetRunCommandParameters added in v1.7.9 

func (s *Target) SetRunCommandParameters(v *RunCommandParameters) *Target

SetRunCommandParameters sets the RunCommandParameters field's value.

func (*Target) SetSageMakerPipelineParameters added in v1.38.7 

func (s *Target) SetSageMakerPipelineParameters(v *SageMakerPipelineParameters) *Target

SetSageMakerPipelineParameters sets the SageMakerPipelineParameters field's value.

func (*Target) SetSqsParameters added in v1.13.17 

func (s *Target) SetSqsParameters(v *SqsParameters) *Target

SetSqsParameters sets the SqsParameters field's value.

func (Target) String 

func (s Target) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Target) Validate added in v1.1.21 

func (s *Target) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestEventPatternInput 

type TestEventPatternInput struct {

	// The event, in JSON format, to test against the event pattern. The JSON must
	// follow the format specified in Amazon Web Services Events (https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html),
	// and the following fields are mandatory:
	//
	//    * id
	//
	//    * account
	//
	//    * source
	//
	//    * time
	//
	//    * region
	//
	//    * resources
	//
	//    * detail-type
	//
	// 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) GoString 

func (s TestEventPatternInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestEventPatternInput) SetEvent added in v1.5.0 

func (s *TestEventPatternInput) SetEvent(v string) *TestEventPatternInput

SetEvent sets the Event field's value.

func (*TestEventPatternInput) SetEventPattern added in v1.5.0 

func (s *TestEventPatternInput) SetEventPattern(v string) *TestEventPatternInput

SetEventPattern sets the EventPattern field's value.

func (TestEventPatternInput) String 

func (s TestEventPatternInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestEventPatternInput) Validate added in v1.1.21 

func (s *TestEventPatternInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TestEventPatternOutput 

type TestEventPatternOutput struct {

	// Indicates whether the event matches the event pattern.
	Result *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (TestEventPatternOutput) GoString 

func (s TestEventPatternOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TestEventPatternOutput) SetResult added in v1.5.0 

func (s *TestEventPatternOutput) SetResult(v bool) *TestEventPatternOutput

SetResult sets the Result field's value.

func (TestEventPatternOutput) String 

func (s TestEventPatternOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.19.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) GoString added in v1.19.0 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceARN added in v1.19.0 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.19.0 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.19.0 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.19.0 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.19.0 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.19.0 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.19.0 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateApiDestinationInput added in v1.37.24 

type UpdateApiDestinationInput struct {

	// The ARN of the connection to use for the API destination.
	ConnectionArn *string `min:"1" type:"string"`

	// The name of the API destination to update.
	Description *string `type:"string"`

	// The method to use for the API destination.
	HttpMethod *string `type:"string" enum:"ApiDestinationHttpMethod"`

	// The URL to the endpoint to use for the API destination.
	InvocationEndpoint *string `min:"1" type:"string"`

	// The maximum number of invocations per second to send to the API destination.
	InvocationRateLimitPerSecond *int64 `min:"1" type:"integer"`

	// The name of the API destination to update.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateApiDestinationInput) GoString added in v1.37.24 

func (s UpdateApiDestinationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApiDestinationInput) SetConnectionArn added in v1.37.24 

func (s *UpdateApiDestinationInput) SetConnectionArn(v string) *UpdateApiDestinationInput

SetConnectionArn sets the ConnectionArn field's value.

func (*UpdateApiDestinationInput) SetDescription added in v1.37.24 

func (s *UpdateApiDestinationInput) SetDescription(v string) *UpdateApiDestinationInput

SetDescription sets the Description field's value.

func (*UpdateApiDestinationInput) SetHttpMethod added in v1.37.24 

func (s *UpdateApiDestinationInput) SetHttpMethod(v string) *UpdateApiDestinationInput

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateApiDestinationInput) SetInvocationEndpoint added in v1.37.24 

func (s *UpdateApiDestinationInput) SetInvocationEndpoint(v string) *UpdateApiDestinationInput

SetInvocationEndpoint sets the InvocationEndpoint field's value.

func (*UpdateApiDestinationInput) SetInvocationRateLimitPerSecond added in v1.37.24 

func (s *UpdateApiDestinationInput) SetInvocationRateLimitPerSecond(v int64) *UpdateApiDestinationInput

SetInvocationRateLimitPerSecond sets the InvocationRateLimitPerSecond field's value.

func (*UpdateApiDestinationInput) SetName added in v1.37.24 

func (s *UpdateApiDestinationInput) SetName(v string) *UpdateApiDestinationInput

SetName sets the Name field's value.

func (UpdateApiDestinationInput) String added in v1.37.24 

func (s UpdateApiDestinationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApiDestinationInput) Validate added in v1.37.24 

func (s *UpdateApiDestinationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateApiDestinationOutput added in v1.37.24 

type UpdateApiDestinationOutput struct {

	// The ARN of the API destination that was updated.
	ApiDestinationArn *string `min:"1" type:"string"`

	// The state of the API destination that was updated.
	ApiDestinationState *string `type:"string" enum:"ApiDestinationState"`

	// A time stamp for the time that the API destination was created.
	CreationTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the API destination was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (UpdateApiDestinationOutput) GoString added in v1.37.24 

func (s UpdateApiDestinationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateApiDestinationOutput) SetApiDestinationArn added in v1.37.24 

func (s *UpdateApiDestinationOutput) SetApiDestinationArn(v string) *UpdateApiDestinationOutput

SetApiDestinationArn sets the ApiDestinationArn field's value.

func (*UpdateApiDestinationOutput) SetApiDestinationState added in v1.37.24 

func (s *UpdateApiDestinationOutput) SetApiDestinationState(v string) *UpdateApiDestinationOutput

SetApiDestinationState sets the ApiDestinationState field's value.

func (*UpdateApiDestinationOutput) SetCreationTime added in v1.37.24 

func (s *UpdateApiDestinationOutput) SetCreationTime(v time.Time) *UpdateApiDestinationOutput

SetCreationTime sets the CreationTime field's value.

func (*UpdateApiDestinationOutput) SetLastModifiedTime added in v1.37.24 

func (s *UpdateApiDestinationOutput) SetLastModifiedTime(v time.Time) *UpdateApiDestinationOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (UpdateApiDestinationOutput) String added in v1.37.24 

func (s UpdateApiDestinationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateArchiveInput added in v1.35.22 

type UpdateArchiveInput struct {

	// The name of the archive to update.
	//
	// ArchiveName is a required field
	ArchiveName *string `min:"1" type:"string" required:"true"`

	// The description for the archive.
	Description *string `type:"string"`

	// The event pattern to use to filter events sent to the archive.
	EventPattern *string `type:"string"`

	// The number of days to retain events in the archive.
	RetentionDays *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateArchiveInput) GoString added in v1.35.22 

func (s UpdateArchiveInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateArchiveInput) SetArchiveName added in v1.35.22 

func (s *UpdateArchiveInput) SetArchiveName(v string) *UpdateArchiveInput

SetArchiveName sets the ArchiveName field's value.

func (*UpdateArchiveInput) SetDescription added in v1.35.22 

func (s *UpdateArchiveInput) SetDescription(v string) *UpdateArchiveInput

SetDescription sets the Description field's value.

func (*UpdateArchiveInput) SetEventPattern added in v1.35.22 

func (s *UpdateArchiveInput) SetEventPattern(v string) *UpdateArchiveInput

SetEventPattern sets the EventPattern field's value.

func (*UpdateArchiveInput) SetRetentionDays added in v1.35.22 

func (s *UpdateArchiveInput) SetRetentionDays(v int64) *UpdateArchiveInput

SetRetentionDays sets the RetentionDays field's value.

func (UpdateArchiveInput) String added in v1.35.22 

func (s UpdateArchiveInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateArchiveInput) Validate added in v1.35.22 

func (s *UpdateArchiveInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateArchiveOutput added in v1.35.22 

type UpdateArchiveOutput struct {

	// The ARN of the archive.
	ArchiveArn *string `min:"1" type:"string"`

	// The time at which the archive was updated.
	CreationTime *time.Time `type:"timestamp"`

	// The state of the archive.
	State *string `type:"string" enum:"ArchiveState"`

	// The reason that the archive is in the current state.
	StateReason *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateArchiveOutput) GoString added in v1.35.22 

func (s UpdateArchiveOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateArchiveOutput) SetArchiveArn added in v1.35.22 

func (s *UpdateArchiveOutput) SetArchiveArn(v string) *UpdateArchiveOutput

SetArchiveArn sets the ArchiveArn field's value.

func (*UpdateArchiveOutput) SetCreationTime added in v1.35.22 

func (s *UpdateArchiveOutput) SetCreationTime(v time.Time) *UpdateArchiveOutput

SetCreationTime sets the CreationTime field's value.

func (*UpdateArchiveOutput) SetState added in v1.35.22 

func (s *UpdateArchiveOutput) SetState(v string) *UpdateArchiveOutput

SetState sets the State field's value.

func (*UpdateArchiveOutput) SetStateReason added in v1.35.22 

func (s *UpdateArchiveOutput) SetStateReason(v string) *UpdateArchiveOutput

SetStateReason sets the StateReason field's value.

func (UpdateArchiveOutput) String added in v1.35.22 

func (s UpdateArchiveOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateConnectionApiKeyAuthRequestParameters added in v1.37.24 

type UpdateConnectionApiKeyAuthRequestParameters struct {

	// The name of the API key to use for authorization.
	ApiKeyName *string `min:"1" type:"string"`

	// The value associated with teh API key to use for authorization.
	//
	// ApiKeyValue is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateConnectionApiKeyAuthRequestParameters's
	// String and GoString methods.
	ApiKeyValue *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the API key authorization parameters to use to update the connection.

func (UpdateConnectionApiKeyAuthRequestParameters) GoString added in v1.37.24 

func (s UpdateConnectionApiKeyAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionApiKeyAuthRequestParameters) SetApiKeyName added in v1.37.24 

func (s *UpdateConnectionApiKeyAuthRequestParameters) SetApiKeyName(v string) *UpdateConnectionApiKeyAuthRequestParameters

SetApiKeyName sets the ApiKeyName field's value.

func (*UpdateConnectionApiKeyAuthRequestParameters) SetApiKeyValue added in v1.37.24 

func (s *UpdateConnectionApiKeyAuthRequestParameters) SetApiKeyValue(v string) *UpdateConnectionApiKeyAuthRequestParameters

SetApiKeyValue sets the ApiKeyValue field's value.

func (UpdateConnectionApiKeyAuthRequestParameters) String added in v1.37.24 

func (s UpdateConnectionApiKeyAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionApiKeyAuthRequestParameters) Validate added in v1.37.24 

func (s *UpdateConnectionApiKeyAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConnectionAuthRequestParameters added in v1.37.24 

type UpdateConnectionAuthRequestParameters struct {

	// A UpdateConnectionApiKeyAuthRequestParameters object that contains the authorization
	// parameters for API key authorization.
	ApiKeyAuthParameters *UpdateConnectionApiKeyAuthRequestParameters `type:"structure"`

	// A UpdateConnectionBasicAuthRequestParameters object that contains the authorization
	// parameters for Basic authorization.
	BasicAuthParameters *UpdateConnectionBasicAuthRequestParameters `type:"structure"`

	// A ConnectionHttpParameters object that contains the additional parameters
	// to use for the connection.
	InvocationHttpParameters *ConnectionHttpParameters `type:"structure"`

	// A UpdateConnectionOAuthRequestParameters object that contains the authorization
	// parameters for OAuth authorization.
	OAuthParameters *UpdateConnectionOAuthRequestParameters `type:"structure"`
	// contains filtered or unexported fields
}

Contains the additional parameters to use for the connection.

func (UpdateConnectionAuthRequestParameters) GoString added in v1.37.24 

func (s UpdateConnectionAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionAuthRequestParameters) SetApiKeyAuthParameters added in v1.37.24 

func (s *UpdateConnectionAuthRequestParameters) SetApiKeyAuthParameters(v *UpdateConnectionApiKeyAuthRequestParameters) *UpdateConnectionAuthRequestParameters

SetApiKeyAuthParameters sets the ApiKeyAuthParameters field's value.

func (*UpdateConnectionAuthRequestParameters) SetBasicAuthParameters added in v1.37.24 

func (s *UpdateConnectionAuthRequestParameters) SetBasicAuthParameters(v *UpdateConnectionBasicAuthRequestParameters) *UpdateConnectionAuthRequestParameters

SetBasicAuthParameters sets the BasicAuthParameters field's value.

func (*UpdateConnectionAuthRequestParameters) SetInvocationHttpParameters added in v1.37.24 

func (s *UpdateConnectionAuthRequestParameters) SetInvocationHttpParameters(v *ConnectionHttpParameters) *UpdateConnectionAuthRequestParameters

SetInvocationHttpParameters sets the InvocationHttpParameters field's value.

func (*UpdateConnectionAuthRequestParameters) SetOAuthParameters added in v1.37.24 

func (s *UpdateConnectionAuthRequestParameters) SetOAuthParameters(v *UpdateConnectionOAuthRequestParameters) *UpdateConnectionAuthRequestParameters

SetOAuthParameters sets the OAuthParameters field's value.

func (UpdateConnectionAuthRequestParameters) String added in v1.37.24 

func (s UpdateConnectionAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionAuthRequestParameters) Validate added in v1.37.24 

func (s *UpdateConnectionAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConnectionBasicAuthRequestParameters added in v1.37.24 

type UpdateConnectionBasicAuthRequestParameters struct {

	// The password associated with the user name to use for Basic authorization.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateConnectionBasicAuthRequestParameters's
	// String and GoString methods.
	Password *string `min:"1" type:"string" sensitive:"true"`

	// The user name to use for Basic authorization.
	Username *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the Basic authorization parameters for the connection.

func (UpdateConnectionBasicAuthRequestParameters) GoString added in v1.37.24 

func (s UpdateConnectionBasicAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionBasicAuthRequestParameters) SetPassword added in v1.37.24 

func (s *UpdateConnectionBasicAuthRequestParameters) SetPassword(v string) *UpdateConnectionBasicAuthRequestParameters

SetPassword sets the Password field's value.

func (*UpdateConnectionBasicAuthRequestParameters) SetUsername added in v1.37.24 

func (s *UpdateConnectionBasicAuthRequestParameters) SetUsername(v string) *UpdateConnectionBasicAuthRequestParameters

SetUsername sets the Username field's value.

func (UpdateConnectionBasicAuthRequestParameters) String added in v1.37.24 

func (s UpdateConnectionBasicAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionBasicAuthRequestParameters) Validate added in v1.37.24 

func (s *UpdateConnectionBasicAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConnectionInput added in v1.37.24 

type UpdateConnectionInput struct {

	// The authorization parameters to use for the connection.
	AuthParameters *UpdateConnectionAuthRequestParameters `type:"structure"`

	// The type of authorization to use for the connection.
	AuthorizationType *string `type:"string" enum:"ConnectionAuthorizationType"`

	// A description for the connection.
	Description *string `type:"string"`

	// The name of the connection to update.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateConnectionInput) GoString added in v1.37.24 

func (s UpdateConnectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionInput) SetAuthParameters added in v1.37.24 

func (s *UpdateConnectionInput) SetAuthParameters(v *UpdateConnectionAuthRequestParameters) *UpdateConnectionInput

SetAuthParameters sets the AuthParameters field's value.

func (*UpdateConnectionInput) SetAuthorizationType added in v1.37.24 

func (s *UpdateConnectionInput) SetAuthorizationType(v string) *UpdateConnectionInput

SetAuthorizationType sets the AuthorizationType field's value.

func (*UpdateConnectionInput) SetDescription added in v1.37.24 

func (s *UpdateConnectionInput) SetDescription(v string) *UpdateConnectionInput

SetDescription sets the Description field's value.

func (*UpdateConnectionInput) SetName added in v1.37.24 

func (s *UpdateConnectionInput) SetName(v string) *UpdateConnectionInput

SetName sets the Name field's value.

func (UpdateConnectionInput) String added in v1.37.24 

func (s UpdateConnectionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionInput) Validate added in v1.37.24 

func (s *UpdateConnectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConnectionOAuthClientRequestParameters added in v1.37.24 

type UpdateConnectionOAuthClientRequestParameters struct {

	// The client ID to use for OAuth authorization.
	ClientID *string `min:"1" type:"string"`

	// The client secret assciated with the client ID to use for OAuth authorization.
	//
	// ClientSecret is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateConnectionOAuthClientRequestParameters's
	// String and GoString methods.
	ClientSecret *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the OAuth authorization parameters to use for the connection.

func (UpdateConnectionOAuthClientRequestParameters) GoString added in v1.37.24 

func (s UpdateConnectionOAuthClientRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionOAuthClientRequestParameters) SetClientID added in v1.37.24 

func (s *UpdateConnectionOAuthClientRequestParameters) SetClientID(v string) *UpdateConnectionOAuthClientRequestParameters

SetClientID sets the ClientID field's value.

func (*UpdateConnectionOAuthClientRequestParameters) SetClientSecret added in v1.37.24 

func (s *UpdateConnectionOAuthClientRequestParameters) SetClientSecret(v string) *UpdateConnectionOAuthClientRequestParameters

SetClientSecret sets the ClientSecret field's value.

func (UpdateConnectionOAuthClientRequestParameters) String added in v1.37.24 

func (s UpdateConnectionOAuthClientRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionOAuthClientRequestParameters) Validate added in v1.37.24 

func (s *UpdateConnectionOAuthClientRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConnectionOAuthRequestParameters added in v1.37.24 

type UpdateConnectionOAuthRequestParameters struct {

	// The URL to the authorization endpoint when OAuth is specified as the authorization
	// type.
	AuthorizationEndpoint *string `min:"1" type:"string"`

	// A UpdateConnectionOAuthClientRequestParameters object that contains the client
	// parameters to use for the connection when OAuth is specified as the authorization
	// type.
	ClientParameters *UpdateConnectionOAuthClientRequestParameters `type:"structure"`

	// The method used to connect to the HTTP endpoint.
	HttpMethod *string `type:"string" enum:"ConnectionOAuthHttpMethod"`

	// The additional HTTP parameters used for the OAuth authorization request.
	OAuthHttpParameters *ConnectionHttpParameters `type:"structure"`
	// contains filtered or unexported fields
}

Contains the OAuth request parameters to use for the connection.

func (UpdateConnectionOAuthRequestParameters) GoString added in v1.37.24 

func (s UpdateConnectionOAuthRequestParameters) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionOAuthRequestParameters) SetAuthorizationEndpoint added in v1.37.24 

func (s *UpdateConnectionOAuthRequestParameters) SetAuthorizationEndpoint(v string) *UpdateConnectionOAuthRequestParameters

SetAuthorizationEndpoint sets the AuthorizationEndpoint field's value.

func (*UpdateConnectionOAuthRequestParameters) SetClientParameters added in v1.37.24 

func (s *UpdateConnectionOAuthRequestParameters) SetClientParameters(v *UpdateConnectionOAuthClientRequestParameters) *UpdateConnectionOAuthRequestParameters

SetClientParameters sets the ClientParameters field's value.

func (*UpdateConnectionOAuthRequestParameters) SetHttpMethod added in v1.37.24 

func (s *UpdateConnectionOAuthRequestParameters) SetHttpMethod(v string) *UpdateConnectionOAuthRequestParameters

SetHttpMethod sets the HttpMethod field's value.

func (*UpdateConnectionOAuthRequestParameters) SetOAuthHttpParameters added in v1.37.24 

func (s *UpdateConnectionOAuthRequestParameters) SetOAuthHttpParameters(v *ConnectionHttpParameters) *UpdateConnectionOAuthRequestParameters

SetOAuthHttpParameters sets the OAuthHttpParameters field's value.

func (UpdateConnectionOAuthRequestParameters) String added in v1.37.24 

func (s UpdateConnectionOAuthRequestParameters) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionOAuthRequestParameters) Validate added in v1.37.24 

func (s *UpdateConnectionOAuthRequestParameters) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateConnectionOutput added in v1.37.24 

type UpdateConnectionOutput struct {

	// The ARN of the connection that was updated.
	ConnectionArn *string `min:"1" type:"string"`

	// The state of the connection that was updated.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// A time stamp for the time that the connection was created.
	CreationTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last authorized.
	LastAuthorizedTime *time.Time `type:"timestamp"`

	// A time stamp for the time that the connection was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (UpdateConnectionOutput) GoString added in v1.37.24 

func (s UpdateConnectionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionOutput) SetConnectionArn added in v1.37.24 

func (s *UpdateConnectionOutput) SetConnectionArn(v string) *UpdateConnectionOutput

SetConnectionArn sets the ConnectionArn field's value.

func (*UpdateConnectionOutput) SetConnectionState added in v1.37.24 

func (s *UpdateConnectionOutput) SetConnectionState(v string) *UpdateConnectionOutput

SetConnectionState sets the ConnectionState field's value.

func (*UpdateConnectionOutput) SetCreationTime added in v1.37.24 

func (s *UpdateConnectionOutput) SetCreationTime(v time.Time) *UpdateConnectionOutput

SetCreationTime sets the CreationTime field's value.

func (*UpdateConnectionOutput) SetLastAuthorizedTime added in v1.37.24 

func (s *UpdateConnectionOutput) SetLastAuthorizedTime(v time.Time) *UpdateConnectionOutput

SetLastAuthorizedTime sets the LastAuthorizedTime field's value.

func (*UpdateConnectionOutput) SetLastModifiedTime added in v1.37.24 

func (s *UpdateConnectionOutput) SetLastModifiedTime(v time.Time) *UpdateConnectionOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

func (UpdateConnectionOutput) String added in v1.37.24 

func (s UpdateConnectionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.