pipes

package
v1.53.6 Latest Latest
Warning

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

 Go to latest Published: May 20, 2024 License: Apache-2.0 Imports: 10 Imported by: 11

Documentation

Overview

Package pipes provides the client and types for making API requests to Amazon EventBridge Pipes.

Amazon EventBridge Pipes connects event sources to targets. Pipes reduces the need for specialized knowledge and integration code when developing event driven architectures. This helps ensures consistency across your company’s applications. With Pipes, the target can be any available EventBridge target. To set up a pipe, you select the event source, add optional event filtering, define optional enrichment, and select the target for the event data.

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

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

Using the Client

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

Index

Constants

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

	// AssignPublicIpDisabled is a AssignPublicIp enum value
	AssignPublicIpDisabled = "DISABLED"
)
View Source 
const (
	// BatchJobDependencyTypeNToN is a BatchJobDependencyType enum value
	BatchJobDependencyTypeNToN = "N_TO_N"

	// BatchJobDependencyTypeSequential is a BatchJobDependencyType enum value
	BatchJobDependencyTypeSequential = "SEQUENTIAL"
)
View Source 
const (
	// BatchResourceRequirementTypeGpu is a BatchResourceRequirementType enum value
	BatchResourceRequirementTypeGpu = "GPU"

	// BatchResourceRequirementTypeMemory is a BatchResourceRequirementType enum value
	BatchResourceRequirementTypeMemory = "MEMORY"

	// BatchResourceRequirementTypeVcpu is a BatchResourceRequirementType enum value
	BatchResourceRequirementTypeVcpu = "VCPU"
)
View Source 
const (
	// DynamoDBStreamStartPositionTrimHorizon is a DynamoDBStreamStartPosition enum value
	DynamoDBStreamStartPositionTrimHorizon = "TRIM_HORIZON"

	// DynamoDBStreamStartPositionLatest is a DynamoDBStreamStartPosition enum value
	DynamoDBStreamStartPositionLatest = "LATEST"
)
View Source 
const (
	// EcsResourceRequirementTypeGpu is a EcsResourceRequirementType enum value
	EcsResourceRequirementTypeGpu = "GPU"

	// EcsResourceRequirementTypeInferenceAccelerator is a EcsResourceRequirementType enum value
	EcsResourceRequirementTypeInferenceAccelerator = "InferenceAccelerator"
)
View Source 
const (
	// KinesisStreamStartPositionTrimHorizon is a KinesisStreamStartPosition enum value
	KinesisStreamStartPositionTrimHorizon = "TRIM_HORIZON"

	// KinesisStreamStartPositionLatest is a KinesisStreamStartPosition enum value
	KinesisStreamStartPositionLatest = "LATEST"

	// KinesisStreamStartPositionAtTimestamp is a KinesisStreamStartPosition enum value
	KinesisStreamStartPositionAtTimestamp = "AT_TIMESTAMP"
)
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 (
	// LogLevelOff is a LogLevel enum value
	LogLevelOff = "OFF"

	// LogLevelError is a LogLevel enum value
	LogLevelError = "ERROR"

	// LogLevelInfo is a LogLevel enum value
	LogLevelInfo = "INFO"

	// LogLevelTrace is a LogLevel enum value
	LogLevelTrace = "TRACE"
)
View Source 
const (
	// MSKStartPositionTrimHorizon is a MSKStartPosition enum value
	MSKStartPositionTrimHorizon = "TRIM_HORIZON"

	// MSKStartPositionLatest is a MSKStartPosition enum value
	MSKStartPositionLatest = "LATEST"
)
View Source 
const (
	// PipeStateRunning is a PipeState enum value
	PipeStateRunning = "RUNNING"

	// PipeStateStopped is a PipeState enum value
	PipeStateStopped = "STOPPED"

	// PipeStateCreating is a PipeState enum value
	PipeStateCreating = "CREATING"

	// PipeStateUpdating is a PipeState enum value
	PipeStateUpdating = "UPDATING"

	// PipeStateDeleting is a PipeState enum value
	PipeStateDeleting = "DELETING"

	// PipeStateStarting is a PipeState enum value
	PipeStateStarting = "STARTING"

	// PipeStateStopping is a PipeState enum value
	PipeStateStopping = "STOPPING"

	// PipeStateCreateFailed is a PipeState enum value
	PipeStateCreateFailed = "CREATE_FAILED"

	// PipeStateUpdateFailed is a PipeState enum value
	PipeStateUpdateFailed = "UPDATE_FAILED"

	// PipeStateStartFailed is a PipeState enum value
	PipeStateStartFailed = "START_FAILED"

	// PipeStateStopFailed is a PipeState enum value
	PipeStateStopFailed = "STOP_FAILED"

	// PipeStateDeleteFailed is a PipeState enum value
	PipeStateDeleteFailed = "DELETE_FAILED"

	// PipeStateCreateRollbackFailed is a PipeState enum value
	PipeStateCreateRollbackFailed = "CREATE_ROLLBACK_FAILED"

	// PipeStateDeleteRollbackFailed is a PipeState enum value
	PipeStateDeleteRollbackFailed = "DELETE_ROLLBACK_FAILED"

	// PipeStateUpdateRollbackFailed is a PipeState enum value
	PipeStateUpdateRollbackFailed = "UPDATE_ROLLBACK_FAILED"
)
View Source 
const (
	// PipeTargetInvocationTypeRequestResponse is a PipeTargetInvocationType enum value
	PipeTargetInvocationTypeRequestResponse = "REQUEST_RESPONSE"

	// PipeTargetInvocationTypeFireAndForget is a PipeTargetInvocationType enum value
	PipeTargetInvocationTypeFireAndForget = "FIRE_AND_FORGET"
)
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 (
	// RequestedPipeStateRunning is a RequestedPipeState enum value
	RequestedPipeStateRunning = "RUNNING"

	// RequestedPipeStateStopped is a RequestedPipeState enum value
	RequestedPipeStateStopped = "STOPPED"
)
View Source 
const (
	// RequestedPipeStateDescribeResponseRunning is a RequestedPipeStateDescribeResponse enum value
	RequestedPipeStateDescribeResponseRunning = "RUNNING"

	// RequestedPipeStateDescribeResponseStopped is a RequestedPipeStateDescribeResponse enum value
	RequestedPipeStateDescribeResponseStopped = "STOPPED"

	// RequestedPipeStateDescribeResponseDeleted is a RequestedPipeStateDescribeResponse enum value
	RequestedPipeStateDescribeResponseDeleted = "DELETED"
)
View Source 
const (
	// S3OutputFormatJson is a S3OutputFormat enum value
	S3OutputFormatJson = "json"

	// S3OutputFormatPlain is a S3OutputFormat enum value
	S3OutputFormatPlain = "plain"

	// S3OutputFormatW3c is a S3OutputFormat enum value
	S3OutputFormatW3c = "w3c"
)
View Source 
const (
	// SelfManagedKafkaStartPositionTrimHorizon is a SelfManagedKafkaStartPosition enum value
	SelfManagedKafkaStartPositionTrimHorizon = "TRIM_HORIZON"

	// SelfManagedKafkaStartPositionLatest is a SelfManagedKafkaStartPosition enum value
	SelfManagedKafkaStartPositionLatest = "LATEST"
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// An action you attempted resulted in an exception.
	ErrCodeConflictException = "ConflictException"

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

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// An entity that you specified does not exist.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// A quota has been exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// An action was throttled.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Indicates that an error has occurred while performing a validate operation.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Pipes" // Name of service.
	EndpointsID = "pipes" // ID to lookup a service endpoint with.
	ServiceID   = "Pipes" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// EcsEnvironmentFileTypeS3 is a EcsEnvironmentFileType enum value
	EcsEnvironmentFileTypeS3 = "s3"
)
View Source 
const (
	// IncludeExecutionDataOptionAll is a IncludeExecutionDataOption enum value
	IncludeExecutionDataOptionAll = "ALL"
)
View Source 
const (
	// OnPartialBatchItemFailureStreamsAutomaticBisect is a OnPartialBatchItemFailureStreams enum value
	OnPartialBatchItemFailureStreamsAutomaticBisect = "AUTOMATIC_BISECT"
)
View Source 
const (
	// PropagateTagsTaskDefinition is a PropagateTags enum value
	PropagateTagsTaskDefinition = "TASK_DEFINITION"
)

Variables

This section is empty.

Functions

func AssignPublicIp_Values 

func AssignPublicIp_Values() []string

AssignPublicIp_Values returns all elements of the AssignPublicIp enum

func BatchJobDependencyType_Values 

func BatchJobDependencyType_Values() []string

BatchJobDependencyType_Values returns all elements of the BatchJobDependencyType enum

func BatchResourceRequirementType_Values 

func BatchResourceRequirementType_Values() []string

BatchResourceRequirementType_Values returns all elements of the BatchResourceRequirementType enum

func DynamoDBStreamStartPosition_Values 

func DynamoDBStreamStartPosition_Values() []string

DynamoDBStreamStartPosition_Values returns all elements of the DynamoDBStreamStartPosition enum

func EcsEnvironmentFileType_Values 

func EcsEnvironmentFileType_Values() []string

EcsEnvironmentFileType_Values returns all elements of the EcsEnvironmentFileType enum

func EcsResourceRequirementType_Values 

func EcsResourceRequirementType_Values() []string

EcsResourceRequirementType_Values returns all elements of the EcsResourceRequirementType enum

func IncludeExecutionDataOption_Values added in v1.47.11 

func IncludeExecutionDataOption_Values() []string

IncludeExecutionDataOption_Values returns all elements of the IncludeExecutionDataOption enum

func KinesisStreamStartPosition_Values 

func KinesisStreamStartPosition_Values() []string

KinesisStreamStartPosition_Values returns all elements of the KinesisStreamStartPosition enum

func LaunchType_Values 

func LaunchType_Values() []string

LaunchType_Values returns all elements of the LaunchType enum

func LogLevel_Values added in v1.47.11 

func LogLevel_Values() []string

LogLevel_Values returns all elements of the LogLevel enum

func MSKStartPosition_Values 

func MSKStartPosition_Values() []string

MSKStartPosition_Values returns all elements of the MSKStartPosition enum

func OnPartialBatchItemFailureStreams_Values 

func OnPartialBatchItemFailureStreams_Values() []string

OnPartialBatchItemFailureStreams_Values returns all elements of the OnPartialBatchItemFailureStreams enum

func PipeState_Values 

func PipeState_Values() []string

PipeState_Values returns all elements of the PipeState enum

func PipeTargetInvocationType_Values 

func PipeTargetInvocationType_Values() []string

PipeTargetInvocationType_Values returns all elements of the PipeTargetInvocationType enum

func PlacementConstraintType_Values 

func PlacementConstraintType_Values() []string

PlacementConstraintType_Values returns all elements of the PlacementConstraintType enum

func PlacementStrategyType_Values 

func PlacementStrategyType_Values() []string

PlacementStrategyType_Values returns all elements of the PlacementStrategyType enum

func PropagateTags_Values 

func PropagateTags_Values() []string

PropagateTags_Values returns all elements of the PropagateTags enum

func RequestedPipeStateDescribeResponse_Values 

func RequestedPipeStateDescribeResponse_Values() []string

RequestedPipeStateDescribeResponse_Values returns all elements of the RequestedPipeStateDescribeResponse enum

func RequestedPipeState_Values 

func RequestedPipeState_Values() []string

RequestedPipeState_Values returns all elements of the RequestedPipeState enum

func S3OutputFormat_Values added in v1.47.11 

func S3OutputFormat_Values() []string

S3OutputFormat_Values returns all elements of the S3OutputFormat enum

func SelfManagedKafkaStartPosition_Values 

func SelfManagedKafkaStartPosition_Values() []string

SelfManagedKafkaStartPosition_Values returns all elements of the SelfManagedKafkaStartPosition enum

Types

type AwsVpcConfiguration 

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 

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 

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

SetAssignPublicIp sets the AssignPublicIp field's value.

func (*AwsVpcConfiguration) SetSecurityGroups 

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

SetSecurityGroups sets the SecurityGroups field's value.

func (*AwsVpcConfiguration) SetSubnets 

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

SetSubnets sets the Subnets field's value.

func (AwsVpcConfiguration) String 

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 

func (s *AwsVpcConfiguration) Validate() error

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

type BatchArrayProperties 

type BatchArrayProperties struct {

	// The size of the array, if this is an array batch job.
	Size *int64 `min:"2" 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 

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 

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

SetSize sets the Size field's value.

func (BatchArrayProperties) String 

func (s BatchArrayProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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) Validate 

func (s *BatchArrayProperties) Validate() error

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

type BatchContainerOverrides 

type BatchContainerOverrides struct {

	// The command to send to the container that overrides the default command from
	// the Docker image or the task definition.
	Command []*string `type:"list"`

	// The environment variables to send to the container. You can add new environment
	// variables, which are added to the container at launch, or you can override
	// the existing environment variables from the Docker image or the task definition.
	//
	// Environment variables cannot start with "Batch". This naming convention is
	// reserved for variables that Batch sets.
	Environment []*BatchEnvironmentVariable `type:"list"`

	// The instance type to use for a multi-node parallel job.
	//
	// This parameter isn't applicable to single-node container jobs or jobs that
	// run on Fargate resources, and shouldn't be provided.
	InstanceType *string `type:"string"`

	// The type and amount of resources to assign to a container. This overrides
	// the settings in the job definition. The supported resources include GPU,
	// MEMORY, and VCPU.
	ResourceRequirements []*BatchResourceRequirement `type:"list"`
	// contains filtered or unexported fields
}

The overrides that are sent to a container.

func (BatchContainerOverrides) GoString 

func (s BatchContainerOverrides) 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 (*BatchContainerOverrides) SetCommand 

func (s *BatchContainerOverrides) SetCommand(v []*string) *BatchContainerOverrides

SetCommand sets the Command field's value.

func (*BatchContainerOverrides) SetEnvironment 

func (s *BatchContainerOverrides) SetEnvironment(v []*BatchEnvironmentVariable) *BatchContainerOverrides

SetEnvironment sets the Environment field's value.

func (*BatchContainerOverrides) SetInstanceType 

func (s *BatchContainerOverrides) SetInstanceType(v string) *BatchContainerOverrides

SetInstanceType sets the InstanceType field's value.

func (*BatchContainerOverrides) SetResourceRequirements 

func (s *BatchContainerOverrides) SetResourceRequirements(v []*BatchResourceRequirement) *BatchContainerOverrides

SetResourceRequirements sets the ResourceRequirements field's value.

func (BatchContainerOverrides) String 

func (s BatchContainerOverrides) 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 (*BatchContainerOverrides) Validate 

func (s *BatchContainerOverrides) Validate() error

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

type BatchEnvironmentVariable 

type BatchEnvironmentVariable struct {

	// The name of the key-value pair. For environment variables, this is the name
	// of the environment variable.
	Name *string `type:"string"`

	// The value of the key-value pair. For environment variables, this is the value
	// of the environment variable.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

func (BatchEnvironmentVariable) GoString 

func (s BatchEnvironmentVariable) 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 (*BatchEnvironmentVariable) SetName 

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

SetName sets the Name field's value.

func (*BatchEnvironmentVariable) SetValue 

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

SetValue sets the Value field's value.

func (BatchEnvironmentVariable) String 

func (s BatchEnvironmentVariable) 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 BatchJobDependency 

type BatchJobDependency struct {

	// The job ID of the Batch job that's associated with this dependency.
	JobId *string `type:"string"`

	// The type of the job dependency.
	Type *string `type:"string" enum:"BatchJobDependencyType"`
	// contains filtered or unexported fields
}

An object that represents an Batch job dependency.

func (BatchJobDependency) GoString 

func (s BatchJobDependency) 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 (*BatchJobDependency) SetJobId 

func (s *BatchJobDependency) SetJobId(v string) *BatchJobDependency

SetJobId sets the JobId field's value.

func (*BatchJobDependency) SetType 

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

SetType sets the Type field's value.

func (BatchJobDependency) String 

func (s BatchJobDependency) 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 BatchResourceRequirement 

type BatchResourceRequirement struct {

	// The type of resource to assign to a container. The supported resources include
	// GPU, MEMORY, and VCPU.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"BatchResourceRequirementType"`

	// The quantity of the specified resource to reserve for the container. The
	// values vary based on the type specified.
	//
	// type="GPU"
	//
	// The number of physical GPUs to reserve for the container. Make sure that
	// the number of GPUs reserved for all containers in a job doesn't exceed the
	// number of available GPUs on the compute resource that the job is launched
	// on.
	//
	// GPUs aren't available for jobs that are running on Fargate resources.
	//
	// type="MEMORY"
	//
	// The memory hard limit (in MiB) present to the container. This parameter is
	// supported for jobs that are running on EC2 resources. If your container attempts
	// to exceed the memory specified, the container is terminated. This parameter
	// maps to Memory in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
	// and the --memory option to docker run (https://docs.docker.com/engine/reference/run/).
	// You must specify at least 4 MiB of memory for a job. This is required but
	// can be specified in several places for multi-node parallel (MNP) jobs. It
	// must be specified for each node at least once. This parameter maps to Memory
	// in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
	// and the --memory option to docker run (https://docs.docker.com/engine/reference/run/).
	//
	// If you're trying to maximize your resource utilization by providing your
	// jobs as much memory as possible for a particular instance type, see Memory
	// management (https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html)
	// in the Batch User Guide.
	//
	// For jobs that are running on Fargate resources, then value is the hard limit
	// (in MiB), and must match one of the supported values and the VCPU values
	// must be one of the values supported for that memory value.
	//
	// value = 512
	//
	// VCPU = 0.25
	//
	// value = 1024
	//
	// VCPU = 0.25 or 0.5
	//
	// value = 2048
	//
	// VCPU = 0.25, 0.5, or 1
	//
	// value = 3072
	//
	// VCPU = 0.5, or 1
	//
	// value = 4096
	//
	// VCPU = 0.5, 1, or 2
	//
	// value = 5120, 6144, or 7168
	//
	// VCPU = 1 or 2
	//
	// value = 8192
	//
	// VCPU = 1, 2, 4, or 8
	//
	// value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360
	//
	// VCPU = 2 or 4
	//
	// value = 16384
	//
	// VCPU = 2, 4, or 8
	//
	// value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696,
	// or 30720
	//
	// VCPU = 4
	//
	// value = 20480, 24576, or 28672
	//
	// VCPU = 4 or 8
	//
	// value = 36864, 45056, 53248, or 61440
	//
	// VCPU = 8
	//
	// value = 32768, 40960, 49152, or 57344
	//
	// VCPU = 8 or 16
	//
	// value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880
	//
	// VCPU = 16
	//
	// type="VCPU"
	//
	// The number of vCPUs reserved for the container. This parameter maps to CpuShares
	// in the Create a container (https://docs.docker.com/engine/api/v1.23/#create-a-container)
	// section of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
	// and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/).
	// Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must
	// specify at least one vCPU. This is required but can be specified in several
	// places; it must be specified for each node at least once.
	//
	// The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs.
	// For more information about Fargate quotas, see Fargate quotas (https://docs.aws.amazon.com/general/latest/gr/ecs-service.html#service-quotas-fargate)
	// in the Amazon Web Services General Reference.
	//
	// For jobs that are running on Fargate resources, then value must match one
	// of the supported values and the MEMORY values must be one of the values supported
	// for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and
	// 16
	//
	// value = 0.25
	//
	// MEMORY = 512, 1024, or 2048
	//
	// value = 0.5
	//
	// MEMORY = 1024, 2048, 3072, or 4096
	//
	// value = 1
	//
	// MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
	//
	// value = 2
	//
	// MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312,
	// 14336, 15360, or 16384
	//
	// value = 4
	//
	// MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408,
	// 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672,
	// 29696, or 30720
	//
	// value = 8
	//
	// MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248,
	// 57344, or 61440
	//
	// value = 16
	//
	// MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496,
	// 114688, or 122880
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

func (BatchResourceRequirement) GoString 

func (s BatchResourceRequirement) 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 (*BatchResourceRequirement) SetType 

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

SetType sets the Type field's value.

func (*BatchResourceRequirement) SetValue 

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

SetValue sets the Value field's value.

func (BatchResourceRequirement) String 

func (s BatchResourceRequirement) 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 (*BatchResourceRequirement) Validate 

func (s *BatchResourceRequirement) Validate() error

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

type BatchRetryStrategy 

type BatchRetryStrategy struct {

	// The number of times to move a job to the RUNNABLE status. If the value of
	// attempts is greater than one, the job is retried on failure the same number
	// of attempts as the value.
	Attempts *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The retry strategy that's associated with a job. For more information, see Automated job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html) in the Batch User Guide.

func (BatchRetryStrategy) GoString 

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 

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

SetAttempts sets the Attempts field's value.

func (BatchRetryStrategy) String 

func (s BatchRetryStrategy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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) Validate 

func (s *BatchRetryStrategy) Validate() error

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

type CapacityProviderStrategyItem 

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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CapacityProviderStrategyItem's
	// String and GoString methods.
	//
	// CapacityProvider is a required field
	CapacityProvider *string `locationName:"capacityProvider" min:"1" type:"string" required:"true" sensitive:"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 

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 

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

SetBase sets the Base field's value.

func (*CapacityProviderStrategyItem) SetCapacityProvider 

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

SetCapacityProvider sets the CapacityProvider field's value.

func (*CapacityProviderStrategyItem) SetWeight 

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

SetWeight sets the Weight field's value.

func (CapacityProviderStrategyItem) String 

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 

func (s *CapacityProviderStrategyItem) Validate() error

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

type CloudwatchLogsLogDestination added in v1.47.11 

type CloudwatchLogsLogDestination struct {

	// The Amazon Web Services Resource Name (ARN) for the CloudWatch log group
	// to which EventBridge sends the log records.
	LogGroupArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Amazon CloudWatch Logs logging configuration settings for the pipe.

func (CloudwatchLogsLogDestination) GoString added in v1.47.11 

func (s CloudwatchLogsLogDestination) 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 (*CloudwatchLogsLogDestination) SetLogGroupArn added in v1.47.11 

func (s *CloudwatchLogsLogDestination) SetLogGroupArn(v string) *CloudwatchLogsLogDestination

SetLogGroupArn sets the LogGroupArn field's value.

func (CloudwatchLogsLogDestination) String added in v1.47.11 

func (s CloudwatchLogsLogDestination) 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 CloudwatchLogsLogDestinationParameters added in v1.47.11 

type CloudwatchLogsLogDestinationParameters struct {

	// The Amazon Web Services Resource Name (ARN) for the CloudWatch log group
	// to which EventBridge sends the log records.
	//
	// LogGroupArn is a required field
	LogGroupArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Amazon CloudWatch Logs logging configuration settings for the pipe.

func (CloudwatchLogsLogDestinationParameters) GoString added in v1.47.11 

func (s CloudwatchLogsLogDestinationParameters) 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 (*CloudwatchLogsLogDestinationParameters) SetLogGroupArn added in v1.47.11 

func (s *CloudwatchLogsLogDestinationParameters) SetLogGroupArn(v string) *CloudwatchLogsLogDestinationParameters

SetLogGroupArn sets the LogGroupArn field's value.

func (CloudwatchLogsLogDestinationParameters) String added in v1.47.11 

func (s CloudwatchLogsLogDestinationParameters) 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 (*CloudwatchLogsLogDestinationParameters) Validate added in v1.47.11 

func (s *CloudwatchLogsLogDestinationParameters) Validate() error

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

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that caused the exception.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of resource that caused the exception.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An action you attempted resulted in an exception.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) 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 (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) 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 CreatePipeInput 

type CreatePipeInput struct {

	// A description of the pipe.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePipeInput's
	// String and GoString methods.
	Description *string `type:"string" sensitive:"true"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeState"`

	// The ARN of the enrichment resource.
	Enrichment *string `type:"string"`

	// The parameters required to set up enrichment on your pipe.
	EnrichmentParameters *PipeEnrichmentParameters `type:"structure"`

	// The logging configuration settings for the pipe.
	LogConfiguration *PipeLogConfigurationParameters `type:"structure"`

	// The name of the pipe.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`

	// The ARN of the role that allows the pipe to send data to the target.
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`

	// The ARN of the source resource.
	//
	// Source is a required field
	Source *string `min:"1" type:"string" required:"true"`

	// The parameters required to set up a source for your pipe.
	SourceParameters *PipeSourceParameters `type:"structure"`

	// The list of key-value pairs to associate with the pipe.
	Tags map[string]*string `min:"1" type:"map"`

	// The ARN of the target resource.
	//
	// Target is a required field
	Target *string `min:"1" type:"string" required:"true"`

	// The parameters required to set up a target for your pipe.
	//
	// For more information about pipe target parameters, including how to use dynamic
	// path parameters, see Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html)
	// in the Amazon EventBridge User Guide.
	TargetParameters *PipeTargetParameters `type:"structure"`
	// contains filtered or unexported fields
}

func (CreatePipeInput) GoString 

func (s CreatePipeInput) 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 (*CreatePipeInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreatePipeInput) SetDesiredState 

func (s *CreatePipeInput) SetDesiredState(v string) *CreatePipeInput

SetDesiredState sets the DesiredState field's value.

func (*CreatePipeInput) SetEnrichment 

func (s *CreatePipeInput) SetEnrichment(v string) *CreatePipeInput

SetEnrichment sets the Enrichment field's value.

func (*CreatePipeInput) SetEnrichmentParameters 

func (s *CreatePipeInput) SetEnrichmentParameters(v *PipeEnrichmentParameters) *CreatePipeInput

SetEnrichmentParameters sets the EnrichmentParameters field's value.

func (*CreatePipeInput) SetLogConfiguration added in v1.47.11 

func (s *CreatePipeInput) SetLogConfiguration(v *PipeLogConfigurationParameters) *CreatePipeInput

SetLogConfiguration sets the LogConfiguration field's value.

func (*CreatePipeInput) SetName 

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

SetName sets the Name field's value.

func (*CreatePipeInput) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*CreatePipeInput) SetSource 

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

SetSource sets the Source field's value.

func (*CreatePipeInput) SetSourceParameters 

func (s *CreatePipeInput) SetSourceParameters(v *PipeSourceParameters) *CreatePipeInput

SetSourceParameters sets the SourceParameters field's value.

func (*CreatePipeInput) SetTags 

func (s *CreatePipeInput) SetTags(v map[string]*string) *CreatePipeInput

SetTags sets the Tags field's value.

func (*CreatePipeInput) SetTarget 

func (s *CreatePipeInput) SetTarget(v string) *CreatePipeInput

SetTarget sets the Target field's value.

func (*CreatePipeInput) SetTargetParameters 

func (s *CreatePipeInput) SetTargetParameters(v *PipeTargetParameters) *CreatePipeInput

SetTargetParameters sets the TargetParameters field's value.

func (CreatePipeInput) String 

func (s CreatePipeInput) 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 (*CreatePipeInput) Validate 

func (s *CreatePipeInput) Validate() error

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

type CreatePipeOutput 

type CreatePipeOutput struct {

	// The ARN of the pipe.
	Arn *string `min:"1" type:"string"`

	// The time the pipe was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state the pipe is in.
	CurrentState *string `type:"string" enum:"PipeState"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeState"`

	// When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)
	// (YYYY-MM-DDThh:mm:ss.sTZD).
	LastModifiedTime *time.Time `type:"timestamp"`

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

func (CreatePipeOutput) GoString 

func (s CreatePipeOutput) 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 (*CreatePipeOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*CreatePipeOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*CreatePipeOutput) SetCurrentState 

func (s *CreatePipeOutput) SetCurrentState(v string) *CreatePipeOutput

SetCurrentState sets the CurrentState field's value.

func (*CreatePipeOutput) SetDesiredState 

func (s *CreatePipeOutput) SetDesiredState(v string) *CreatePipeOutput

SetDesiredState sets the DesiredState field's value.

func (*CreatePipeOutput) SetLastModifiedTime 

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

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*CreatePipeOutput) SetName 

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

SetName sets the Name field's value.

func (CreatePipeOutput) String 

func (s CreatePipeOutput) 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 

type DeadLetterConfig struct {

	// The ARN of the specified target for the dead-letter queue.
	//
	// For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify either
	// an Amazon SNS topic or Amazon SQS queue ARN.
	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 

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 

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

SetArn sets the Arn field's value.

func (DeadLetterConfig) String 

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 

func (s *DeadLetterConfig) Validate() error

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

type DeletePipeInput 

type DeletePipeInput struct {

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

func (DeletePipeInput) GoString 

func (s DeletePipeInput) 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 (*DeletePipeInput) SetName 

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

SetName sets the Name field's value.

func (DeletePipeInput) String 

func (s DeletePipeInput) 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 (*DeletePipeInput) Validate 

func (s *DeletePipeInput) Validate() error

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

type DeletePipeOutput 

type DeletePipeOutput struct {

	// The ARN of the pipe.
	Arn *string `min:"1" type:"string"`

	// The time the pipe was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state the pipe is in.
	CurrentState *string `type:"string" enum:"PipeState"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeStateDescribeResponse"`

	// When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)
	// (YYYY-MM-DDThh:mm:ss.sTZD).
	LastModifiedTime *time.Time `type:"timestamp"`

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

func (DeletePipeOutput) GoString 

func (s DeletePipeOutput) 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 (*DeletePipeOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*DeletePipeOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*DeletePipeOutput) SetCurrentState 

func (s *DeletePipeOutput) SetCurrentState(v string) *DeletePipeOutput

SetCurrentState sets the CurrentState field's value.

func (*DeletePipeOutput) SetDesiredState 

func (s *DeletePipeOutput) SetDesiredState(v string) *DeletePipeOutput

SetDesiredState sets the DesiredState field's value.

func (*DeletePipeOutput) SetLastModifiedTime 

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

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DeletePipeOutput) SetName 

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

SetName sets the Name field's value.

func (DeletePipeOutput) String 

func (s DeletePipeOutput) 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 DescribePipeInput 

type DescribePipeInput struct {

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

func (DescribePipeInput) GoString 

func (s DescribePipeInput) 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 (*DescribePipeInput) SetName 

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

SetName sets the Name field's value.

func (DescribePipeInput) String 

func (s DescribePipeInput) 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 (*DescribePipeInput) Validate 

func (s *DescribePipeInput) Validate() error

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

type DescribePipeOutput 

type DescribePipeOutput struct {

	// The ARN of the pipe.
	Arn *string `min:"1" type:"string"`

	// The time the pipe was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state the pipe is in.
	CurrentState *string `type:"string" enum:"PipeState"`

	// A description of the pipe.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by DescribePipeOutput's
	// String and GoString methods.
	Description *string `type:"string" sensitive:"true"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeStateDescribeResponse"`

	// The ARN of the enrichment resource.
	Enrichment *string `type:"string"`

	// The parameters required to set up enrichment on your pipe.
	EnrichmentParameters *PipeEnrichmentParameters `type:"structure"`

	// When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)
	// (YYYY-MM-DDThh:mm:ss.sTZD).
	LastModifiedTime *time.Time `type:"timestamp"`

	// The logging configuration settings for the pipe.
	LogConfiguration *PipeLogConfiguration `type:"structure"`

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

	// The ARN of the role that allows the pipe to send data to the target.
	RoleArn *string `min:"1" type:"string"`

	// The ARN of the source resource.
	Source *string `min:"1" type:"string"`

	// The parameters required to set up a source for your pipe.
	SourceParameters *PipeSourceParameters `type:"structure"`

	// The reason the pipe is in its current state.
	StateReason *string `type:"string"`

	// The list of key-value pairs to associate with the pipe.
	Tags map[string]*string `min:"1" type:"map"`

	// The ARN of the target resource.
	Target *string `min:"1" type:"string"`

	// The parameters required to set up a target for your pipe.
	//
	// For more information about pipe target parameters, including how to use dynamic
	// path parameters, see Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html)
	// in the Amazon EventBridge User Guide.
	TargetParameters *PipeTargetParameters `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribePipeOutput) GoString 

func (s DescribePipeOutput) 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 (*DescribePipeOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*DescribePipeOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*DescribePipeOutput) SetCurrentState 

func (s *DescribePipeOutput) SetCurrentState(v string) *DescribePipeOutput

SetCurrentState sets the CurrentState field's value.

func (*DescribePipeOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*DescribePipeOutput) SetDesiredState 

func (s *DescribePipeOutput) SetDesiredState(v string) *DescribePipeOutput

SetDesiredState sets the DesiredState field's value.

func (*DescribePipeOutput) SetEnrichment 

func (s *DescribePipeOutput) SetEnrichment(v string) *DescribePipeOutput

SetEnrichment sets the Enrichment field's value.

func (*DescribePipeOutput) SetEnrichmentParameters 

func (s *DescribePipeOutput) SetEnrichmentParameters(v *PipeEnrichmentParameters) *DescribePipeOutput

SetEnrichmentParameters sets the EnrichmentParameters field's value.

func (*DescribePipeOutput) SetLastModifiedTime 

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

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DescribePipeOutput) SetLogConfiguration added in v1.47.11 

func (s *DescribePipeOutput) SetLogConfiguration(v *PipeLogConfiguration) *DescribePipeOutput

SetLogConfiguration sets the LogConfiguration field's value.

func (*DescribePipeOutput) SetName 

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

SetName sets the Name field's value.

func (*DescribePipeOutput) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*DescribePipeOutput) SetSource 

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

SetSource sets the Source field's value.

func (*DescribePipeOutput) SetSourceParameters 

func (s *DescribePipeOutput) SetSourceParameters(v *PipeSourceParameters) *DescribePipeOutput

SetSourceParameters sets the SourceParameters field's value.

func (*DescribePipeOutput) SetStateReason 

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

SetStateReason sets the StateReason field's value.

func (*DescribePipeOutput) SetTags 

func (s *DescribePipeOutput) SetTags(v map[string]*string) *DescribePipeOutput

SetTags sets the Tags field's value.

func (*DescribePipeOutput) SetTarget 

func (s *DescribePipeOutput) SetTarget(v string) *DescribePipeOutput

SetTarget sets the Target field's value.

func (*DescribePipeOutput) SetTargetParameters 

func (s *DescribePipeOutput) SetTargetParameters(v *PipeTargetParameters) *DescribePipeOutput

SetTargetParameters sets the TargetParameters field's value.

func (DescribePipeOutput) String 

func (s DescribePipeOutput) 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 EcsContainerOverride 

type EcsContainerOverride struct {

	// The command to send to the container that overrides the default command from
	// the Docker image or the task definition. You must also specify a container
	// name.
	Command []*string `type:"list"`

	// The number of cpu units reserved for the container, instead of the default
	// value from the task definition. You must also specify a container name.
	Cpu *int64 `type:"integer"`

	// The environment variables to send to the container. You can add new environment
	// variables, which are added to the container at launch, or you can override
	// the existing environment variables from the Docker image or the task definition.
	// You must also specify a container name.
	Environment []*EcsEnvironmentVariable `type:"list"`

	// A list of files containing the environment variables to pass to a container,
	// instead of the value from the container definition.
	EnvironmentFiles []*EcsEnvironmentFile `type:"list"`

	// The hard limit (in MiB) of memory to present to the container, instead of
	// the default value from the task definition. If your container attempts to
	// exceed the memory specified here, the container is killed. You must also
	// specify a container name.
	Memory *int64 `type:"integer"`

	// The soft limit (in MiB) of memory to reserve for the container, instead of
	// the default value from the task definition. You must also specify a container
	// name.
	MemoryReservation *int64 `type:"integer"`

	// The name of the container that receives the override. This parameter is required
	// if any override is specified.
	Name *string `type:"string"`

	// The type and amount of a resource to assign to a container, instead of the
	// default value from the task definition. The only supported resource is a
	// GPU.
	ResourceRequirements []*EcsResourceRequirement `type:"list"`
	// contains filtered or unexported fields
}

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

func (EcsContainerOverride) GoString 

func (s EcsContainerOverride) 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 (*EcsContainerOverride) SetCommand 

func (s *EcsContainerOverride) SetCommand(v []*string) *EcsContainerOverride

SetCommand sets the Command field's value.

func (*EcsContainerOverride) SetCpu 

func (s *EcsContainerOverride) SetCpu(v int64) *EcsContainerOverride

SetCpu sets the Cpu field's value.

func (*EcsContainerOverride) SetEnvironment 

func (s *EcsContainerOverride) SetEnvironment(v []*EcsEnvironmentVariable) *EcsContainerOverride

SetEnvironment sets the Environment field's value.

func (*EcsContainerOverride) SetEnvironmentFiles 

func (s *EcsContainerOverride) SetEnvironmentFiles(v []*EcsEnvironmentFile) *EcsContainerOverride

SetEnvironmentFiles sets the EnvironmentFiles field's value.

func (*EcsContainerOverride) SetMemory 

func (s *EcsContainerOverride) SetMemory(v int64) *EcsContainerOverride

SetMemory sets the Memory field's value.

func (*EcsContainerOverride) SetMemoryReservation 

func (s *EcsContainerOverride) SetMemoryReservation(v int64) *EcsContainerOverride

SetMemoryReservation sets the MemoryReservation field's value.

func (*EcsContainerOverride) SetName 

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

SetName sets the Name field's value.

func (*EcsContainerOverride) SetResourceRequirements 

func (s *EcsContainerOverride) SetResourceRequirements(v []*EcsResourceRequirement) *EcsContainerOverride

SetResourceRequirements sets the ResourceRequirements field's value.

func (EcsContainerOverride) String 

func (s EcsContainerOverride) 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 (*EcsContainerOverride) Validate 

func (s *EcsContainerOverride) Validate() error

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

type EcsEnvironmentFile 

type EcsEnvironmentFile struct {

	// The file type to use. The only supported value is s3.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"EcsEnvironmentFileType"`

	// The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment
	// variable file.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/).

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the Amazon Elastic Container Service Developer Guide.

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

func (EcsEnvironmentFile) GoString 

func (s EcsEnvironmentFile) 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 (*EcsEnvironmentFile) SetType 

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

SetType sets the Type field's value.

func (*EcsEnvironmentFile) SetValue 

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

SetValue sets the Value field's value.

func (EcsEnvironmentFile) String 

func (s EcsEnvironmentFile) 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 (*EcsEnvironmentFile) Validate 

func (s *EcsEnvironmentFile) Validate() error

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

type EcsEnvironmentVariable 

type EcsEnvironmentVariable struct {

	// The name of the key-value pair. For environment variables, this is the name
	// of the environment variable.
	Name *string `locationName:"name" type:"string"`

	// The value of the key-value pair. For environment variables, this is the value
	// of the environment variable.
	Value *string `locationName:"value" type:"string"`
	// contains filtered or unexported fields
}

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

func (EcsEnvironmentVariable) GoString 

func (s EcsEnvironmentVariable) 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 (*EcsEnvironmentVariable) SetName 

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

SetName sets the Name field's value.

func (*EcsEnvironmentVariable) SetValue 

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

SetValue sets the Value field's value.

func (EcsEnvironmentVariable) String 

func (s EcsEnvironmentVariable) 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 EcsEphemeralStorage 

type EcsEphemeralStorage struct {

	// The total amount, in GiB, of ephemeral storage to set for the task. The minimum
	// supported value is 21 GiB and the maximum supported value is 200 GiB.
	//
	// SizeInGiB is a required field
	SizeInGiB *int64 `locationName:"sizeInGiB" min:"21" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html) in the Amazon ECS User Guide for Fargate.

This parameter is only supported for tasks hosted on Fargate using Linux platform version 1.4.0 or later. This parameter is not supported for Windows containers on Fargate.

func (EcsEphemeralStorage) GoString 

func (s EcsEphemeralStorage) 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 (*EcsEphemeralStorage) SetSizeInGiB 

func (s *EcsEphemeralStorage) SetSizeInGiB(v int64) *EcsEphemeralStorage

SetSizeInGiB sets the SizeInGiB field's value.

func (EcsEphemeralStorage) String 

func (s EcsEphemeralStorage) 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 (*EcsEphemeralStorage) Validate 

func (s *EcsEphemeralStorage) Validate() error

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

type EcsInferenceAcceleratorOverride 

type EcsInferenceAcceleratorOverride struct {

	// The Elastic Inference accelerator device name to override for the task. This
	// parameter must match a deviceName specified in the task definition.
	DeviceName *string `locationName:"deviceName" type:"string"`

	// The Elastic Inference accelerator type to use.
	DeviceType *string `locationName:"deviceType" type:"string"`
	// contains filtered or unexported fields
}

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html) in the Amazon Elastic Container Service Developer Guide.

func (EcsInferenceAcceleratorOverride) GoString 

func (s EcsInferenceAcceleratorOverride) 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 (*EcsInferenceAcceleratorOverride) SetDeviceName 

func (s *EcsInferenceAcceleratorOverride) SetDeviceName(v string) *EcsInferenceAcceleratorOverride

SetDeviceName sets the DeviceName field's value.

func (*EcsInferenceAcceleratorOverride) SetDeviceType 

func (s *EcsInferenceAcceleratorOverride) SetDeviceType(v string) *EcsInferenceAcceleratorOverride

SetDeviceType sets the DeviceType field's value.

func (EcsInferenceAcceleratorOverride) String 

func (s EcsInferenceAcceleratorOverride) 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 EcsResourceRequirement 

type EcsResourceRequirement struct {

	// The type of resource to assign to a container. The supported values are GPU
	// or InferenceAccelerator.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"EcsResourceRequirementType"`

	// The value for the specified resource type.
	//
	// If the GPU type is used, the value is the number of physical GPUs the Amazon
	// ECS container agent reserves for the container. The number of GPUs that's
	// reserved for all containers in a task can't exceed the number of available
	// GPUs on the container instance that the task is launched on.
	//
	// If the InferenceAccelerator type is used, the value matches the deviceName
	// for an InferenceAccelerator specified in a task definition.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html) or Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html) in the Amazon Elastic Container Service Developer Guide

func (EcsResourceRequirement) GoString 

func (s EcsResourceRequirement) 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 (*EcsResourceRequirement) SetType 

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

SetType sets the Type field's value.

func (*EcsResourceRequirement) SetValue 

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

SetValue sets the Value field's value.

func (EcsResourceRequirement) String 

func (s EcsResourceRequirement) 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 (*EcsResourceRequirement) Validate 

func (s *EcsResourceRequirement) Validate() error

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

type EcsTaskOverride 

type EcsTaskOverride struct {

	// One or more container overrides that are sent to a task.
	ContainerOverrides []*EcsContainerOverride `type:"list"`

	// The cpu override for the task.
	Cpu *string `type:"string"`

	// The ephemeral storage setting override for the task.
	//
	// This parameter is only supported for tasks hosted on Fargate that use the
	// following platform versions:
	//
	//    * Linux platform version 1.4.0 or later.
	//
	//    * Windows platform version 1.0.0 or later.
	EphemeralStorage *EcsEphemeralStorage `type:"structure"`

	// The Amazon Resource Name (ARN) of the task execution IAM role override for
	// the task. For more information, see Amazon ECS task execution IAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)
	// in the Amazon Elastic Container Service Developer Guide.
	ExecutionRoleArn *string `min:"1" type:"string"`

	// The Elastic Inference accelerator override for the task.
	InferenceAcceleratorOverrides []*EcsInferenceAcceleratorOverride `type:"list"`

	// The memory override for the task.
	Memory *string `type:"string"`

	// The Amazon Resource Name (ARN) of the IAM role that containers in this task
	// can assume. All containers in this task are granted the permissions that
	// are specified in this role. For more information, see IAM Role for Tasks
	// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)
	// in the Amazon Elastic Container Service Developer Guide.
	TaskRoleArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The overrides that are associated with a task.

func (EcsTaskOverride) GoString 

func (s EcsTaskOverride) 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 (*EcsTaskOverride) SetContainerOverrides 

func (s *EcsTaskOverride) SetContainerOverrides(v []*EcsContainerOverride) *EcsTaskOverride

SetContainerOverrides sets the ContainerOverrides field's value.

func (*EcsTaskOverride) SetCpu 

func (s *EcsTaskOverride) SetCpu(v string) *EcsTaskOverride

SetCpu sets the Cpu field's value.

func (*EcsTaskOverride) SetEphemeralStorage 

func (s *EcsTaskOverride) SetEphemeralStorage(v *EcsEphemeralStorage) *EcsTaskOverride

SetEphemeralStorage sets the EphemeralStorage field's value.

func (*EcsTaskOverride) SetExecutionRoleArn 

func (s *EcsTaskOverride) SetExecutionRoleArn(v string) *EcsTaskOverride

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*EcsTaskOverride) SetInferenceAcceleratorOverrides 

func (s *EcsTaskOverride) SetInferenceAcceleratorOverrides(v []*EcsInferenceAcceleratorOverride) *EcsTaskOverride

SetInferenceAcceleratorOverrides sets the InferenceAcceleratorOverrides field's value.

func (*EcsTaskOverride) SetMemory 

func (s *EcsTaskOverride) SetMemory(v string) *EcsTaskOverride

SetMemory sets the Memory field's value.

func (*EcsTaskOverride) SetTaskRoleArn 

func (s *EcsTaskOverride) SetTaskRoleArn(v string) *EcsTaskOverride

SetTaskRoleArn sets the TaskRoleArn field's value.

func (EcsTaskOverride) String 

func (s EcsTaskOverride) 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 (*EcsTaskOverride) Validate 

func (s *EcsTaskOverride) Validate() error

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

type Filter 

type Filter struct {

	// The event pattern.
	//
	// Pattern is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Filter's
	// String and GoString methods.
	Pattern *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Filter events using an 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.

func (Filter) GoString 

func (s Filter) 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 (*Filter) SetPattern 

func (s *Filter) SetPattern(v string) *Filter

SetPattern sets the Pattern field's value.

func (Filter) String 

func (s Filter) 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 FilterCriteria 

type FilterCriteria struct {

	// The event patterns.
	Filters []*Filter `type:"list"`
	// contains filtered or unexported fields
}

The collection of event patterns used to filter events.

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

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.

func (FilterCriteria) GoString 

func (s FilterCriteria) 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 (*FilterCriteria) SetFilters 

func (s *FilterCriteria) SetFilters(v []*Filter) *FilterCriteria

SetFilters sets the Filters field's value.

func (FilterCriteria) String 

func (s FilterCriteria) 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 FirehoseLogDestination added in v1.47.11 

type FirehoseLogDestination struct {

	// The Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream
	// to which EventBridge delivers the pipe log records.
	DeliveryStreamArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

func (FirehoseLogDestination) GoString added in v1.47.11 

func (s FirehoseLogDestination) 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 (*FirehoseLogDestination) SetDeliveryStreamArn added in v1.47.11 

func (s *FirehoseLogDestination) SetDeliveryStreamArn(v string) *FirehoseLogDestination

SetDeliveryStreamArn sets the DeliveryStreamArn field's value.

func (FirehoseLogDestination) String added in v1.47.11 

func (s FirehoseLogDestination) 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 FirehoseLogDestinationParameters added in v1.47.11 

type FirehoseLogDestinationParameters struct {

	// Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery
	// stream to which EventBridge delivers the pipe log records.
	//
	// DeliveryStreamArn is a required field
	DeliveryStreamArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

func (FirehoseLogDestinationParameters) GoString added in v1.47.11 

func (s FirehoseLogDestinationParameters) 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 (*FirehoseLogDestinationParameters) SetDeliveryStreamArn added in v1.47.11 

func (s *FirehoseLogDestinationParameters) SetDeliveryStreamArn(v string) *FirehoseLogDestinationParameters

SetDeliveryStreamArn sets the DeliveryStreamArn field's value.

func (FirehoseLogDestinationParameters) String added in v1.47.11 

func (s FirehoseLogDestinationParameters) 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 (*FirehoseLogDestinationParameters) Validate added in v1.47.11 

func (s *FirehoseLogDestinationParameters) Validate() error

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

type InternalException 

type InternalException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The number of seconds to wait before retrying the action that caused the
	// exception.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`
	// contains filtered or unexported fields
}

This exception occurs due to unexpected causes.

func (*InternalException) Code 

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error 

func (s *InternalException) Error() string

func (InternalException) GoString 

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 

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr 

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID 

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode 

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String 

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 ListPipesInput 

type ListPipesInput struct {

	// The state the pipe is in.
	CurrentState *string `location:"querystring" locationName:"CurrentState" type:"string" enum:"PipeState"`

	// The state the pipe should be in.
	DesiredState *string `location:"querystring" locationName:"DesiredState" type:"string" enum:"RequestedPipeState"`

	// The maximum number of pipes to include in the response.
	Limit *int64 `location:"querystring" locationName:"Limit" min:"1" type:"integer"`

	// A value that will return a subset of the pipes associated with this account.
	// For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in
	// the name.
	NamePrefix *string `location:"querystring" locationName:"NamePrefix" min:"1" type:"string"`

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListPipesInput's
	// String and GoString methods.
	NextToken *string `location:"querystring" locationName:"NextToken" min:"1" type:"string" sensitive:"true"`

	// The prefix matching the pipe source.
	SourcePrefix *string `location:"querystring" locationName:"SourcePrefix" min:"1" type:"string"`

	// The prefix matching the pipe target.
	TargetPrefix *string `location:"querystring" locationName:"TargetPrefix" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPipesInput) GoString 

func (s ListPipesInput) 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 (*ListPipesInput) SetCurrentState 

func (s *ListPipesInput) SetCurrentState(v string) *ListPipesInput

SetCurrentState sets the CurrentState field's value.

func (*ListPipesInput) SetDesiredState 

func (s *ListPipesInput) SetDesiredState(v string) *ListPipesInput

SetDesiredState sets the DesiredState field's value.

func (*ListPipesInput) SetLimit 

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

SetLimit sets the Limit field's value.

func (*ListPipesInput) SetNamePrefix 

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

SetNamePrefix sets the NamePrefix field's value.

func (*ListPipesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListPipesInput) SetSourcePrefix 

func (s *ListPipesInput) SetSourcePrefix(v string) *ListPipesInput

SetSourcePrefix sets the SourcePrefix field's value.

func (*ListPipesInput) SetTargetPrefix 

func (s *ListPipesInput) SetTargetPrefix(v string) *ListPipesInput

SetTargetPrefix sets the TargetPrefix field's value.

func (ListPipesInput) String 

func (s ListPipesInput) 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 (*ListPipesInput) Validate 

func (s *ListPipesInput) Validate() error

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

type ListPipesOutput 

type ListPipesOutput struct {

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. Make the call again
	// using the returned token to retrieve the next page. Keep all other arguments
	// unchanged. Each pagination token expires after 24 hours. Using an expired
	// pagination token will return an HTTP 400 InvalidToken error.
	//
	// NextToken is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListPipesOutput's
	// String and GoString methods.
	NextToken *string `min:"1" type:"string" sensitive:"true"`

	// The pipes returned by the call.
	Pipes []*Pipe `type:"list"`
	// contains filtered or unexported fields
}

func (ListPipesOutput) GoString 

func (s ListPipesOutput) 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 (*ListPipesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListPipesOutput) SetPipes 

func (s *ListPipesOutput) SetPipes(v []*Pipe) *ListPipesOutput

SetPipes sets the Pipes field's value.

func (ListPipesOutput) String 

func (s ListPipesOutput) 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 

type ListTagsForResourceInput struct {

	// The ARN of the pipe for which you want to view tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

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 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

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 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of key-value pairs to associate with the pipe.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

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 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

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 MQBrokerAccessCredentials 

type MQBrokerAccessCredentials struct {

	// The ARN of the Secrets Manager secret.
	BasicAuth *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Secrets Manager secret that stores your broker credentials.

func (MQBrokerAccessCredentials) GoString 

func (s MQBrokerAccessCredentials) 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 (*MQBrokerAccessCredentials) SetBasicAuth 

func (s *MQBrokerAccessCredentials) SetBasicAuth(v string) *MQBrokerAccessCredentials

SetBasicAuth sets the BasicAuth field's value.

func (MQBrokerAccessCredentials) String 

func (s MQBrokerAccessCredentials) 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 (*MQBrokerAccessCredentials) Validate 

func (s *MQBrokerAccessCredentials) Validate() error

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

type MSKAccessCredentials 

type MSKAccessCredentials struct {

	// The ARN of the Secrets Manager secret.
	ClientCertificateTlsAuth *string `min:"1" type:"string"`

	// The ARN of the Secrets Manager secret.
	SaslScram512Auth *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Secrets Manager secret that stores your stream credentials.

func (MSKAccessCredentials) GoString 

func (s MSKAccessCredentials) 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 (*MSKAccessCredentials) SetClientCertificateTlsAuth 

func (s *MSKAccessCredentials) SetClientCertificateTlsAuth(v string) *MSKAccessCredentials

SetClientCertificateTlsAuth sets the ClientCertificateTlsAuth field's value.

func (*MSKAccessCredentials) SetSaslScram512Auth 

func (s *MSKAccessCredentials) SetSaslScram512Auth(v string) *MSKAccessCredentials

SetSaslScram512Auth sets the SaslScram512Auth field's value.

func (MSKAccessCredentials) String 

func (s MSKAccessCredentials) 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 (*MSKAccessCredentials) Validate 

func (s *MSKAccessCredentials) Validate() error

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

type NetworkConfiguration 

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 Amazon ECS task.

func (NetworkConfiguration) GoString 

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 

func (s *NetworkConfiguration) SetAwsvpcConfiguration(v *AwsVpcConfiguration) *NetworkConfiguration

SetAwsvpcConfiguration sets the AwsvpcConfiguration field's value.

func (NetworkConfiguration) String 

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 

func (s *NetworkConfiguration) Validate() error

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

type NotFoundException 

type NotFoundException 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 (*NotFoundException) Code 

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error 

func (s *NotFoundException) Error() string

func (NotFoundException) GoString 

func (s NotFoundException) 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 (*NotFoundException) Message 

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr 

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID 

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode 

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String 

func (s NotFoundException) 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 Pipe 

type Pipe struct {

	// The ARN of the pipe.
	Arn *string `min:"1" type:"string"`

	// The time the pipe was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state the pipe is in.
	CurrentState *string `type:"string" enum:"PipeState"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeState"`

	// The ARN of the enrichment resource.
	Enrichment *string `type:"string"`

	// When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)
	// (YYYY-MM-DDThh:mm:ss.sTZD).
	LastModifiedTime *time.Time `type:"timestamp"`

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

	// The ARN of the source resource.
	Source *string `min:"1" type:"string"`

	// The reason the pipe is in its current state.
	StateReason *string `type:"string"`

	// The ARN of the target resource.
	Target *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

func (Pipe) GoString 

func (s Pipe) 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 (*Pipe) SetArn 

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

SetArn sets the Arn field's value.

func (*Pipe) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*Pipe) SetCurrentState 

func (s *Pipe) SetCurrentState(v string) *Pipe

SetCurrentState sets the CurrentState field's value.

func (*Pipe) SetDesiredState 

func (s *Pipe) SetDesiredState(v string) *Pipe

SetDesiredState sets the DesiredState field's value.

func (*Pipe) SetEnrichment 

func (s *Pipe) SetEnrichment(v string) *Pipe

SetEnrichment sets the Enrichment field's value.

func (*Pipe) SetLastModifiedTime 

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

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*Pipe) SetName 

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

SetName sets the Name field's value.

func (*Pipe) SetSource 

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

SetSource sets the Source field's value.

func (*Pipe) SetStateReason 

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

SetStateReason sets the StateReason field's value.

func (*Pipe) SetTarget 

func (s *Pipe) SetTarget(v string) *Pipe

SetTarget sets the Target field's value.

func (Pipe) String 

func (s Pipe) 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 PipeEnrichmentHttpParameters 

type PipeEnrichmentHttpParameters 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 (PipeEnrichmentHttpParameters) GoString 

func (s PipeEnrichmentHttpParameters) 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 (*PipeEnrichmentHttpParameters) SetHeaderParameters 

func (s *PipeEnrichmentHttpParameters) SetHeaderParameters(v map[string]*string) *PipeEnrichmentHttpParameters

SetHeaderParameters sets the HeaderParameters field's value.

func (*PipeEnrichmentHttpParameters) SetPathParameterValues 

func (s *PipeEnrichmentHttpParameters) SetPathParameterValues(v []*string) *PipeEnrichmentHttpParameters

SetPathParameterValues sets the PathParameterValues field's value.

func (*PipeEnrichmentHttpParameters) SetQueryStringParameters 

func (s *PipeEnrichmentHttpParameters) SetQueryStringParameters(v map[string]*string) *PipeEnrichmentHttpParameters

SetQueryStringParameters sets the QueryStringParameters field's value.

func (PipeEnrichmentHttpParameters) String 

func (s PipeEnrichmentHttpParameters) 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 PipeEnrichmentParameters 

type PipeEnrichmentParameters struct {

	// 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 *PipeEnrichmentHttpParameters `type:"structure"`

	// Valid JSON text passed to the enrichment. In this case, nothing from the
	// event itself is passed to the enrichment. For more information, see The JavaScript
	// Object Notation (JSON) Data Interchange Format (http://www.rfc-editor.org/rfc/rfc7159.txt).
	//
	// To remove an input template, specify an empty string.
	//
	// InputTemplate is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeEnrichmentParameters's
	// String and GoString methods.
	InputTemplate *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The parameters required to set up enrichment on your pipe.

func (PipeEnrichmentParameters) GoString 

func (s PipeEnrichmentParameters) 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 (*PipeEnrichmentParameters) SetHttpParameters 

func (s *PipeEnrichmentParameters) SetHttpParameters(v *PipeEnrichmentHttpParameters) *PipeEnrichmentParameters

SetHttpParameters sets the HttpParameters field's value.

func (*PipeEnrichmentParameters) SetInputTemplate 

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

SetInputTemplate sets the InputTemplate field's value.

func (PipeEnrichmentParameters) String 

func (s PipeEnrichmentParameters) 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 PipeLogConfiguration added in v1.47.11 

type PipeLogConfiguration struct {

	// The Amazon CloudWatch Logs logging configuration settings for the pipe.
	CloudwatchLogsLogDestination *CloudwatchLogsLogDestination `type:"structure"`

	// The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
	FirehoseLogDestination *FirehoseLogDestination `type:"structure"`

	// Whether the execution data (specifically, the payload, awsRequest, and awsResponse
	// fields) is included in the log messages for this pipe.
	//
	// This applies to all log destinations for the pipe.
	//
	// For more information, see Including execution data in logs (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data)
	// in the Amazon EventBridge User Guide.
	IncludeExecutionData []*string `type:"list" enum:"IncludeExecutionDataOption"`

	// The level of logging detail to include. This applies to all log destinations
	// for the pipe.
	Level *string `type:"string" enum:"LogLevel"`

	// The Amazon S3 logging configuration settings for the pipe.
	S3LogDestination *S3LogDestination `type:"structure"`
	// contains filtered or unexported fields
}

The logging configuration settings for the pipe.

func (PipeLogConfiguration) GoString added in v1.47.11 

func (s PipeLogConfiguration) 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 (*PipeLogConfiguration) SetCloudwatchLogsLogDestination added in v1.47.11 

func (s *PipeLogConfiguration) SetCloudwatchLogsLogDestination(v *CloudwatchLogsLogDestination) *PipeLogConfiguration

SetCloudwatchLogsLogDestination sets the CloudwatchLogsLogDestination field's value.

func (*PipeLogConfiguration) SetFirehoseLogDestination added in v1.47.11 

func (s *PipeLogConfiguration) SetFirehoseLogDestination(v *FirehoseLogDestination) *PipeLogConfiguration

SetFirehoseLogDestination sets the FirehoseLogDestination field's value.

func (*PipeLogConfiguration) SetIncludeExecutionData added in v1.47.11 

func (s *PipeLogConfiguration) SetIncludeExecutionData(v []*string) *PipeLogConfiguration

SetIncludeExecutionData sets the IncludeExecutionData field's value.

func (*PipeLogConfiguration) SetLevel added in v1.47.11 

func (s *PipeLogConfiguration) SetLevel(v string) *PipeLogConfiguration

SetLevel sets the Level field's value.

func (*PipeLogConfiguration) SetS3LogDestination added in v1.47.11 

func (s *PipeLogConfiguration) SetS3LogDestination(v *S3LogDestination) *PipeLogConfiguration

SetS3LogDestination sets the S3LogDestination field's value.

func (PipeLogConfiguration) String added in v1.47.11 

func (s PipeLogConfiguration) 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 PipeLogConfigurationParameters added in v1.47.11 

type PipeLogConfigurationParameters struct {

	// The Amazon CloudWatch Logs logging configuration settings for the pipe.
	CloudwatchLogsLogDestination *CloudwatchLogsLogDestinationParameters `type:"structure"`

	// The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
	FirehoseLogDestination *FirehoseLogDestinationParameters `type:"structure"`

	// Specify ON to include the execution data (specifically, the payload and awsRequest
	// fields) in the log messages for this pipe.
	//
	// This applies to all log destinations for the pipe.
	//
	// For more information, see Including execution data in logs (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-execution-data)
	// in the Amazon EventBridge User Guide.
	//
	// The default is OFF.
	IncludeExecutionData []*string `type:"list" enum:"IncludeExecutionDataOption"`

	// The level of logging detail to include. This applies to all log destinations
	// for the pipe.
	//
	// For more information, see Specifying EventBridge Pipes log level (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html#eb-pipes-logs-level)
	// in the Amazon EventBridge User Guide.
	//
	// Level is a required field
	Level *string `type:"string" required:"true" enum:"LogLevel"`

	// The Amazon S3 logging configuration settings for the pipe.
	S3LogDestination *S3LogDestinationParameters `type:"structure"`
	// contains filtered or unexported fields
}

Specifies the logging configuration settings for the pipe.

When you call UpdatePipe, EventBridge updates the fields in the PipeLogConfigurationParameters object atomically as one and overrides existing values. This is by design. If you don't specify an optional field in any of the Amazon Web Services service parameters objects (CloudwatchLogsLogDestinationParameters, FirehoseLogDestinationParameters, or S3LogDestinationParameters), EventBridge sets that field to its system-default value during the update.

For example, suppose when you created the pipe you specified a Kinesis Data Firehose stream log destination. You then update the pipe to add an Amazon S3 log destination. In addition to specifying the S3LogDestinationParameters for the new log destination, you must also specify the fields in the FirehoseLogDestinationParameters object in order to retain the Kinesis Data Firehose stream log destination.

For more information on generating pipe log records, see Log EventBridge Pipes (eventbridge/latest/userguide/eb-pipes-logs.html) in the Amazon EventBridge User Guide.

func (PipeLogConfigurationParameters) GoString added in v1.47.11 

func (s PipeLogConfigurationParameters) 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 (*PipeLogConfigurationParameters) SetCloudwatchLogsLogDestination added in v1.47.11 

func (s *PipeLogConfigurationParameters) SetCloudwatchLogsLogDestination(v *CloudwatchLogsLogDestinationParameters) *PipeLogConfigurationParameters

SetCloudwatchLogsLogDestination sets the CloudwatchLogsLogDestination field's value.

func (*PipeLogConfigurationParameters) SetFirehoseLogDestination added in v1.47.11 

func (s *PipeLogConfigurationParameters) SetFirehoseLogDestination(v *FirehoseLogDestinationParameters) *PipeLogConfigurationParameters

SetFirehoseLogDestination sets the FirehoseLogDestination field's value.

func (*PipeLogConfigurationParameters) SetIncludeExecutionData added in v1.47.11 

func (s *PipeLogConfigurationParameters) SetIncludeExecutionData(v []*string) *PipeLogConfigurationParameters

SetIncludeExecutionData sets the IncludeExecutionData field's value.

func (*PipeLogConfigurationParameters) SetLevel added in v1.47.11 

func (s *PipeLogConfigurationParameters) SetLevel(v string) *PipeLogConfigurationParameters

SetLevel sets the Level field's value.

func (*PipeLogConfigurationParameters) SetS3LogDestination added in v1.47.11 

func (s *PipeLogConfigurationParameters) SetS3LogDestination(v *S3LogDestinationParameters) *PipeLogConfigurationParameters

SetS3LogDestination sets the S3LogDestination field's value.

func (PipeLogConfigurationParameters) String added in v1.47.11 

func (s PipeLogConfigurationParameters) 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 (*PipeLogConfigurationParameters) Validate added in v1.47.11 

func (s *PipeLogConfigurationParameters) Validate() error

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

type PipeSourceActiveMQBrokerParameters 

type PipeSourceActiveMQBrokerParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The credentials needed to access the resource.
	//
	// Credentials is a required field
	Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// The name of the destination queue to consume.
	//
	// QueueName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeSourceActiveMQBrokerParameters's
	// String and GoString methods.
	//
	// QueueName is a required field
	QueueName *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The parameters for using an Active MQ broker as a source.

func (PipeSourceActiveMQBrokerParameters) GoString 

func (s PipeSourceActiveMQBrokerParameters) 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 (*PipeSourceActiveMQBrokerParameters) SetBatchSize 

func (s *PipeSourceActiveMQBrokerParameters) SetBatchSize(v int64) *PipeSourceActiveMQBrokerParameters

SetBatchSize sets the BatchSize field's value.

func (*PipeSourceActiveMQBrokerParameters) SetCredentials 

func (s *PipeSourceActiveMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *PipeSourceActiveMQBrokerParameters

SetCredentials sets the Credentials field's value.

func (*PipeSourceActiveMQBrokerParameters) SetMaximumBatchingWindowInSeconds 

func (s *PipeSourceActiveMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceActiveMQBrokerParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*PipeSourceActiveMQBrokerParameters) SetQueueName 

func (s *PipeSourceActiveMQBrokerParameters) SetQueueName(v string) *PipeSourceActiveMQBrokerParameters

SetQueueName sets the QueueName field's value.

func (PipeSourceActiveMQBrokerParameters) String 

func (s PipeSourceActiveMQBrokerParameters) 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 (*PipeSourceActiveMQBrokerParameters) Validate 

func (s *PipeSourceActiveMQBrokerParameters) Validate() error

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

type PipeSourceDynamoDBStreamParameters 

type PipeSourceDynamoDBStreamParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// Define the target queue to send dead-letter queue events to.
	DeadLetterConfig *DeadLetterConfig `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records older than the specified age. The default
	// value is -1, which sets the maximum age to infinite. When the value is set
	// to infinite, EventBridge never discards old records.
	MaximumRecordAgeInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records after the specified number of retries. The
	// default value is -1, which sets the maximum number of retries to infinite.
	// When MaximumRetryAttempts is infinite, EventBridge retries failed records
	// until the record expires in the event source.
	MaximumRetryAttempts *int64 `type:"integer"`

	// (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT
	// halves each batch and retry each half until all the records are processed
	// or there is one failed message left in the batch.
	OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"`

	// (Streams only) The number of batches to process concurrently from each shard.
	// The default value is 1.
	ParallelizationFactor *int64 `min:"1" type:"integer"`

	// (Streams only) The position in a stream from which to start reading.
	//
	// StartingPosition is a required field
	StartingPosition *string `type:"string" required:"true" enum:"DynamoDBStreamStartPosition"`
	// contains filtered or unexported fields
}

The parameters for using a DynamoDB stream as a source.

func (PipeSourceDynamoDBStreamParameters) GoString 

func (s PipeSourceDynamoDBStreamParameters) 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 (*PipeSourceDynamoDBStreamParameters) SetBatchSize 

func (s *PipeSourceDynamoDBStreamParameters) SetBatchSize(v int64) *PipeSourceDynamoDBStreamParameters

SetBatchSize sets the BatchSize field's value.

func (*PipeSourceDynamoDBStreamParameters) SetDeadLetterConfig 

func (s *PipeSourceDynamoDBStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *PipeSourceDynamoDBStreamParameters

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*PipeSourceDynamoDBStreamParameters) SetMaximumBatchingWindowInSeconds 

func (s *PipeSourceDynamoDBStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceDynamoDBStreamParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*PipeSourceDynamoDBStreamParameters) SetMaximumRecordAgeInSeconds 

func (s *PipeSourceDynamoDBStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *PipeSourceDynamoDBStreamParameters

SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value.

func (*PipeSourceDynamoDBStreamParameters) SetMaximumRetryAttempts 

func (s *PipeSourceDynamoDBStreamParameters) SetMaximumRetryAttempts(v int64) *PipeSourceDynamoDBStreamParameters

SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value.

func (*PipeSourceDynamoDBStreamParameters) SetOnPartialBatchItemFailure 

func (s *PipeSourceDynamoDBStreamParameters) SetOnPartialBatchItemFailure(v string) *PipeSourceDynamoDBStreamParameters

SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value.

func (*PipeSourceDynamoDBStreamParameters) SetParallelizationFactor 

func (s *PipeSourceDynamoDBStreamParameters) SetParallelizationFactor(v int64) *PipeSourceDynamoDBStreamParameters

SetParallelizationFactor sets the ParallelizationFactor field's value.

func (*PipeSourceDynamoDBStreamParameters) SetStartingPosition 

func (s *PipeSourceDynamoDBStreamParameters) SetStartingPosition(v string) *PipeSourceDynamoDBStreamParameters

SetStartingPosition sets the StartingPosition field's value.

func (PipeSourceDynamoDBStreamParameters) String 

func (s PipeSourceDynamoDBStreamParameters) 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 (*PipeSourceDynamoDBStreamParameters) Validate 

func (s *PipeSourceDynamoDBStreamParameters) Validate() error

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

type PipeSourceKinesisStreamParameters 

type PipeSourceKinesisStreamParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// Define the target queue to send dead-letter queue events to.
	DeadLetterConfig *DeadLetterConfig `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records older than the specified age. The default
	// value is -1, which sets the maximum age to infinite. When the value is set
	// to infinite, EventBridge never discards old records.
	MaximumRecordAgeInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records after the specified number of retries. The
	// default value is -1, which sets the maximum number of retries to infinite.
	// When MaximumRetryAttempts is infinite, EventBridge retries failed records
	// until the record expires in the event source.
	MaximumRetryAttempts *int64 `type:"integer"`

	// (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT
	// halves each batch and retry each half until all the records are processed
	// or there is one failed message left in the batch.
	OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"`

	// (Streams only) The number of batches to process concurrently from each shard.
	// The default value is 1.
	ParallelizationFactor *int64 `min:"1" type:"integer"`

	// (Streams only) The position in a stream from which to start reading.
	//
	// StartingPosition is a required field
	StartingPosition *string `type:"string" required:"true" enum:"KinesisStreamStartPosition"`

	// With StartingPosition set to AT_TIMESTAMP, the time from which to start reading,
	// in Unix time seconds.
	StartingPositionTimestamp *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

The parameters for using a Kinesis stream as a source.

func (PipeSourceKinesisStreamParameters) GoString 

func (s PipeSourceKinesisStreamParameters) 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 (*PipeSourceKinesisStreamParameters) SetBatchSize 

func (s *PipeSourceKinesisStreamParameters) SetBatchSize(v int64) *PipeSourceKinesisStreamParameters

SetBatchSize sets the BatchSize field's value.

func (*PipeSourceKinesisStreamParameters) SetDeadLetterConfig 

func (s *PipeSourceKinesisStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *PipeSourceKinesisStreamParameters

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*PipeSourceKinesisStreamParameters) SetMaximumBatchingWindowInSeconds 

func (s *PipeSourceKinesisStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceKinesisStreamParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*PipeSourceKinesisStreamParameters) SetMaximumRecordAgeInSeconds 

func (s *PipeSourceKinesisStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *PipeSourceKinesisStreamParameters

SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value.

func (*PipeSourceKinesisStreamParameters) SetMaximumRetryAttempts 

func (s *PipeSourceKinesisStreamParameters) SetMaximumRetryAttempts(v int64) *PipeSourceKinesisStreamParameters

SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value.

func (*PipeSourceKinesisStreamParameters) SetOnPartialBatchItemFailure 

func (s *PipeSourceKinesisStreamParameters) SetOnPartialBatchItemFailure(v string) *PipeSourceKinesisStreamParameters

SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value.

func (*PipeSourceKinesisStreamParameters) SetParallelizationFactor 

func (s *PipeSourceKinesisStreamParameters) SetParallelizationFactor(v int64) *PipeSourceKinesisStreamParameters

SetParallelizationFactor sets the ParallelizationFactor field's value.

func (*PipeSourceKinesisStreamParameters) SetStartingPosition 

func (s *PipeSourceKinesisStreamParameters) SetStartingPosition(v string) *PipeSourceKinesisStreamParameters

SetStartingPosition sets the StartingPosition field's value.

func (*PipeSourceKinesisStreamParameters) SetStartingPositionTimestamp 

func (s *PipeSourceKinesisStreamParameters) SetStartingPositionTimestamp(v time.Time) *PipeSourceKinesisStreamParameters

SetStartingPositionTimestamp sets the StartingPositionTimestamp field's value.

func (PipeSourceKinesisStreamParameters) String 

func (s PipeSourceKinesisStreamParameters) 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 (*PipeSourceKinesisStreamParameters) Validate 

func (s *PipeSourceKinesisStreamParameters) Validate() error

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

type PipeSourceManagedStreamingKafkaParameters 

type PipeSourceManagedStreamingKafkaParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The name of the destination queue to consume.
	//
	// ConsumerGroupID is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeSourceManagedStreamingKafkaParameters's
	// String and GoString methods.
	ConsumerGroupID *string `min:"1" type:"string" sensitive:"true"`

	// The credentials needed to access the resource.
	Credentials *MSKAccessCredentials `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// (Streams only) The position in a stream from which to start reading.
	StartingPosition *string `type:"string" enum:"MSKStartPosition"`

	// The name of the topic that the pipe will read from.
	//
	// TopicName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeSourceManagedStreamingKafkaParameters's
	// String and GoString methods.
	//
	// TopicName is a required field
	TopicName *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The parameters for using an MSK stream as a source.

func (PipeSourceManagedStreamingKafkaParameters) GoString 

func (s PipeSourceManagedStreamingKafkaParameters) 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 (*PipeSourceManagedStreamingKafkaParameters) SetBatchSize 

func (s *PipeSourceManagedStreamingKafkaParameters) SetBatchSize(v int64) *PipeSourceManagedStreamingKafkaParameters

SetBatchSize sets the BatchSize field's value.

func (*PipeSourceManagedStreamingKafkaParameters) SetConsumerGroupID 

func (s *PipeSourceManagedStreamingKafkaParameters) SetConsumerGroupID(v string) *PipeSourceManagedStreamingKafkaParameters

SetConsumerGroupID sets the ConsumerGroupID field's value.

func (*PipeSourceManagedStreamingKafkaParameters) SetCredentials 

func (s *PipeSourceManagedStreamingKafkaParameters) SetCredentials(v *MSKAccessCredentials) *PipeSourceManagedStreamingKafkaParameters

SetCredentials sets the Credentials field's value.

func (*PipeSourceManagedStreamingKafkaParameters) SetMaximumBatchingWindowInSeconds 

func (s *PipeSourceManagedStreamingKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceManagedStreamingKafkaParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*PipeSourceManagedStreamingKafkaParameters) SetStartingPosition 

func (s *PipeSourceManagedStreamingKafkaParameters) SetStartingPosition(v string) *PipeSourceManagedStreamingKafkaParameters

SetStartingPosition sets the StartingPosition field's value.

func (*PipeSourceManagedStreamingKafkaParameters) SetTopicName 

func (s *PipeSourceManagedStreamingKafkaParameters) SetTopicName(v string) *PipeSourceManagedStreamingKafkaParameters

SetTopicName sets the TopicName field's value.

func (PipeSourceManagedStreamingKafkaParameters) String 

func (s PipeSourceManagedStreamingKafkaParameters) 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 (*PipeSourceManagedStreamingKafkaParameters) Validate 

func (s *PipeSourceManagedStreamingKafkaParameters) Validate() error

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

type PipeSourceParameters 

type PipeSourceParameters struct {

	// The parameters for using an Active MQ broker as a source.
	ActiveMQBrokerParameters *PipeSourceActiveMQBrokerParameters `type:"structure"`

	// The parameters for using a DynamoDB stream as a source.
	DynamoDBStreamParameters *PipeSourceDynamoDBStreamParameters `type:"structure"`

	// The collection of event patterns used to filter events.
	//
	// To remove a filter, specify a FilterCriteria object with an empty array of
	// Filter objects.
	//
	// 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.
	FilterCriteria *FilterCriteria `type:"structure"`

	// The parameters for using a Kinesis stream as a source.
	KinesisStreamParameters *PipeSourceKinesisStreamParameters `type:"structure"`

	// The parameters for using an MSK stream as a source.
	ManagedStreamingKafkaParameters *PipeSourceManagedStreamingKafkaParameters `type:"structure"`

	// The parameters for using a Rabbit MQ broker as a source.
	RabbitMQBrokerParameters *PipeSourceRabbitMQBrokerParameters `type:"structure"`

	// The parameters for using a self-managed Apache Kafka stream as a source.
	SelfManagedKafkaParameters *PipeSourceSelfManagedKafkaParameters `type:"structure"`

	// The parameters for using a Amazon SQS stream as a source.
	SqsQueueParameters *PipeSourceSqsQueueParameters `type:"structure"`
	// contains filtered or unexported fields
}

The parameters required to set up a source for your pipe.

func (PipeSourceParameters) GoString 

func (s PipeSourceParameters) 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 (*PipeSourceParameters) SetActiveMQBrokerParameters 

func (s *PipeSourceParameters) SetActiveMQBrokerParameters(v *PipeSourceActiveMQBrokerParameters) *PipeSourceParameters

SetActiveMQBrokerParameters sets the ActiveMQBrokerParameters field's value.

func (*PipeSourceParameters) SetDynamoDBStreamParameters 

func (s *PipeSourceParameters) SetDynamoDBStreamParameters(v *PipeSourceDynamoDBStreamParameters) *PipeSourceParameters

SetDynamoDBStreamParameters sets the DynamoDBStreamParameters field's value.

func (*PipeSourceParameters) SetFilterCriteria 

func (s *PipeSourceParameters) SetFilterCriteria(v *FilterCriteria) *PipeSourceParameters

SetFilterCriteria sets the FilterCriteria field's value.

func (*PipeSourceParameters) SetKinesisStreamParameters 

func (s *PipeSourceParameters) SetKinesisStreamParameters(v *PipeSourceKinesisStreamParameters) *PipeSourceParameters

SetKinesisStreamParameters sets the KinesisStreamParameters field's value.

func (*PipeSourceParameters) SetManagedStreamingKafkaParameters 

func (s *PipeSourceParameters) SetManagedStreamingKafkaParameters(v *PipeSourceManagedStreamingKafkaParameters) *PipeSourceParameters

SetManagedStreamingKafkaParameters sets the ManagedStreamingKafkaParameters field's value.

func (*PipeSourceParameters) SetRabbitMQBrokerParameters 

func (s *PipeSourceParameters) SetRabbitMQBrokerParameters(v *PipeSourceRabbitMQBrokerParameters) *PipeSourceParameters

SetRabbitMQBrokerParameters sets the RabbitMQBrokerParameters field's value.

func (*PipeSourceParameters) SetSelfManagedKafkaParameters 

func (s *PipeSourceParameters) SetSelfManagedKafkaParameters(v *PipeSourceSelfManagedKafkaParameters) *PipeSourceParameters

SetSelfManagedKafkaParameters sets the SelfManagedKafkaParameters field's value.

func (*PipeSourceParameters) SetSqsQueueParameters 

func (s *PipeSourceParameters) SetSqsQueueParameters(v *PipeSourceSqsQueueParameters) *PipeSourceParameters

SetSqsQueueParameters sets the SqsQueueParameters field's value.

func (PipeSourceParameters) String 

func (s PipeSourceParameters) 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 (*PipeSourceParameters) Validate 

func (s *PipeSourceParameters) Validate() error

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

type PipeSourceRabbitMQBrokerParameters 

type PipeSourceRabbitMQBrokerParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The credentials needed to access the resource.
	//
	// Credentials is a required field
	Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// The name of the destination queue to consume.
	//
	// QueueName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeSourceRabbitMQBrokerParameters's
	// String and GoString methods.
	//
	// QueueName is a required field
	QueueName *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The name of the virtual host associated with the source broker.
	//
	// VirtualHost is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeSourceRabbitMQBrokerParameters's
	// String and GoString methods.
	VirtualHost *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The parameters for using a Rabbit MQ broker as a source.

func (PipeSourceRabbitMQBrokerParameters) GoString 

func (s PipeSourceRabbitMQBrokerParameters) 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 (*PipeSourceRabbitMQBrokerParameters) SetBatchSize 

func (s *PipeSourceRabbitMQBrokerParameters) SetBatchSize(v int64) *PipeSourceRabbitMQBrokerParameters

SetBatchSize sets the BatchSize field's value.

func (*PipeSourceRabbitMQBrokerParameters) SetCredentials 

func (s *PipeSourceRabbitMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *PipeSourceRabbitMQBrokerParameters

SetCredentials sets the Credentials field's value.

func (*PipeSourceRabbitMQBrokerParameters) SetMaximumBatchingWindowInSeconds 

func (s *PipeSourceRabbitMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceRabbitMQBrokerParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*PipeSourceRabbitMQBrokerParameters) SetQueueName 

func (s *PipeSourceRabbitMQBrokerParameters) SetQueueName(v string) *PipeSourceRabbitMQBrokerParameters

SetQueueName sets the QueueName field's value.

func (*PipeSourceRabbitMQBrokerParameters) SetVirtualHost 

func (s *PipeSourceRabbitMQBrokerParameters) SetVirtualHost(v string) *PipeSourceRabbitMQBrokerParameters

SetVirtualHost sets the VirtualHost field's value.

func (PipeSourceRabbitMQBrokerParameters) String 

func (s PipeSourceRabbitMQBrokerParameters) 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 (*PipeSourceRabbitMQBrokerParameters) Validate 

func (s *PipeSourceRabbitMQBrokerParameters) Validate() error

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

type PipeSourceSelfManagedKafkaParameters 

type PipeSourceSelfManagedKafkaParameters struct {

	// An array of server URLs.
	AdditionalBootstrapServers []*string `type:"list"`

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The name of the destination queue to consume.
	//
	// ConsumerGroupID is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeSourceSelfManagedKafkaParameters's
	// String and GoString methods.
	ConsumerGroupID *string `min:"1" type:"string" sensitive:"true"`

	// The credentials needed to access the resource.
	Credentials *SelfManagedKafkaAccessConfigurationCredentials `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// The ARN of the Secrets Manager secret used for certification.
	ServerRootCaCertificate *string `min:"1" type:"string"`

	// (Streams only) The position in a stream from which to start reading.
	StartingPosition *string `type:"string" enum:"SelfManagedKafkaStartPosition"`

	// The name of the topic that the pipe will read from.
	//
	// TopicName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeSourceSelfManagedKafkaParameters's
	// String and GoString methods.
	//
	// TopicName is a required field
	TopicName *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// This structure specifies the VPC subnets and security groups for the stream,
	// and whether a public IP address is to be used.
	Vpc *SelfManagedKafkaAccessConfigurationVpc `type:"structure"`
	// contains filtered or unexported fields
}

The parameters for using a self-managed Apache Kafka stream as a source.

func (PipeSourceSelfManagedKafkaParameters) GoString 

func (s PipeSourceSelfManagedKafkaParameters) 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 (*PipeSourceSelfManagedKafkaParameters) SetAdditionalBootstrapServers 

func (s *PipeSourceSelfManagedKafkaParameters) SetAdditionalBootstrapServers(v []*string) *PipeSourceSelfManagedKafkaParameters

SetAdditionalBootstrapServers sets the AdditionalBootstrapServers field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetBatchSize 

func (s *PipeSourceSelfManagedKafkaParameters) SetBatchSize(v int64) *PipeSourceSelfManagedKafkaParameters

SetBatchSize sets the BatchSize field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetConsumerGroupID 

func (s *PipeSourceSelfManagedKafkaParameters) SetConsumerGroupID(v string) *PipeSourceSelfManagedKafkaParameters

SetConsumerGroupID sets the ConsumerGroupID field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetCredentials 

func (s *PipeSourceSelfManagedKafkaParameters) SetCredentials(v *SelfManagedKafkaAccessConfigurationCredentials) *PipeSourceSelfManagedKafkaParameters

SetCredentials sets the Credentials field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetMaximumBatchingWindowInSeconds 

func (s *PipeSourceSelfManagedKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceSelfManagedKafkaParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetServerRootCaCertificate 

func (s *PipeSourceSelfManagedKafkaParameters) SetServerRootCaCertificate(v string) *PipeSourceSelfManagedKafkaParameters

SetServerRootCaCertificate sets the ServerRootCaCertificate field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetStartingPosition 

func (s *PipeSourceSelfManagedKafkaParameters) SetStartingPosition(v string) *PipeSourceSelfManagedKafkaParameters

SetStartingPosition sets the StartingPosition field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetTopicName 

func (s *PipeSourceSelfManagedKafkaParameters) SetTopicName(v string) *PipeSourceSelfManagedKafkaParameters

SetTopicName sets the TopicName field's value.

func (*PipeSourceSelfManagedKafkaParameters) SetVpc 

func (s *PipeSourceSelfManagedKafkaParameters) SetVpc(v *SelfManagedKafkaAccessConfigurationVpc) *PipeSourceSelfManagedKafkaParameters

SetVpc sets the Vpc field's value.

func (PipeSourceSelfManagedKafkaParameters) String 

func (s PipeSourceSelfManagedKafkaParameters) 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 (*PipeSourceSelfManagedKafkaParameters) Validate 

func (s *PipeSourceSelfManagedKafkaParameters) Validate() error

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

type PipeSourceSqsQueueParameters 

type PipeSourceSqsQueueParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The parameters for using a Amazon SQS stream as a source.

func (PipeSourceSqsQueueParameters) GoString 

func (s PipeSourceSqsQueueParameters) 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 (*PipeSourceSqsQueueParameters) SetBatchSize 

func (s *PipeSourceSqsQueueParameters) SetBatchSize(v int64) *PipeSourceSqsQueueParameters

SetBatchSize sets the BatchSize field's value.

func (*PipeSourceSqsQueueParameters) SetMaximumBatchingWindowInSeconds 

func (s *PipeSourceSqsQueueParameters) SetMaximumBatchingWindowInSeconds(v int64) *PipeSourceSqsQueueParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (PipeSourceSqsQueueParameters) String 

func (s PipeSourceSqsQueueParameters) 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 (*PipeSourceSqsQueueParameters) Validate 

func (s *PipeSourceSqsQueueParameters) Validate() error

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

type PipeTargetBatchJobParameters 

type PipeTargetBatchJobParameters 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 overrides that are sent to a container.
	ContainerOverrides *BatchContainerOverrides `type:"structure"`

	// A list of dependencies for the job. A job can depend upon a maximum of 20
	// jobs. You can specify a SEQUENTIAL type dependency without specifying a job
	// ID for array jobs so that each child array job completes sequentially, starting
	// at index 0. You can also specify an N_TO_N type dependency with a job ID
	// for array jobs. In that case, each index child of this job must wait for
	// the corresponding index child of each dependency to complete before it can
	// begin.
	DependsOn []*BatchJobDependency `type:"list"`

	// The job definition used by this job. This value can be one of name, name:revision,
	// or the Amazon Resource Name (ARN) for the job definition. If name is specified
	// without a revision then the latest active revision is used.
	//
	// JobDefinition is a required field
	JobDefinition *string `type:"string" required:"true"`

	// The name of the job. It can be up to 128 letters long. The first character
	// must be alphanumeric, can contain uppercase and lowercase letters, numbers,
	// hyphens (-), and underscores (_).
	//
	// JobName is a required field
	JobName *string `type:"string" required:"true"`

	// Additional parameters passed to the job that replace parameter substitution
	// placeholders that are set in the job definition. Parameters are specified
	// as a key and value pair mapping. Parameters included here override any corresponding
	// parameter defaults from the job definition.
	Parameters map[string]*string `type:"map"`

	// The retry strategy to use for failed jobs. When a retry strategy is specified
	// here, it overrides the retry strategy defined in the job definition.
	RetryStrategy *BatchRetryStrategy `type:"structure"`
	// contains filtered or unexported fields
}

The parameters for using an Batch job as a target.

func (PipeTargetBatchJobParameters) GoString 

func (s PipeTargetBatchJobParameters) 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 (*PipeTargetBatchJobParameters) SetArrayProperties 

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

SetArrayProperties sets the ArrayProperties field's value.

func (*PipeTargetBatchJobParameters) SetContainerOverrides 

func (s *PipeTargetBatchJobParameters) SetContainerOverrides(v *BatchContainerOverrides) *PipeTargetBatchJobParameters

SetContainerOverrides sets the ContainerOverrides field's value.

func (*PipeTargetBatchJobParameters) SetDependsOn 

func (s *PipeTargetBatchJobParameters) SetDependsOn(v []*BatchJobDependency) *PipeTargetBatchJobParameters

SetDependsOn sets the DependsOn field's value.

func (*PipeTargetBatchJobParameters) SetJobDefinition 

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

SetJobDefinition sets the JobDefinition field's value.

func (*PipeTargetBatchJobParameters) SetJobName 

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

SetJobName sets the JobName field's value.

func (*PipeTargetBatchJobParameters) SetParameters 

func (s *PipeTargetBatchJobParameters) SetParameters(v map[string]*string) *PipeTargetBatchJobParameters

SetParameters sets the Parameters field's value.

func (*PipeTargetBatchJobParameters) SetRetryStrategy 

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

SetRetryStrategy sets the RetryStrategy field's value.

func (PipeTargetBatchJobParameters) String 

func (s PipeTargetBatchJobParameters) 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 (*PipeTargetBatchJobParameters) Validate 

func (s *PipeTargetBatchJobParameters) Validate() error

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

type PipeTargetCloudWatchLogsParameters 

type PipeTargetCloudWatchLogsParameters struct {

	// The name of the log stream.
	LogStreamName *string `min:"1" type:"string"`

	// The time the event occurred, expressed as the number of milliseconds after
	// Jan 1, 1970 00:00:00 UTC.
	Timestamp *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The parameters for using an CloudWatch Logs log stream as a target.

func (PipeTargetCloudWatchLogsParameters) GoString 

func (s PipeTargetCloudWatchLogsParameters) 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 (*PipeTargetCloudWatchLogsParameters) SetLogStreamName 

func (s *PipeTargetCloudWatchLogsParameters) SetLogStreamName(v string) *PipeTargetCloudWatchLogsParameters

SetLogStreamName sets the LogStreamName field's value.

func (*PipeTargetCloudWatchLogsParameters) SetTimestamp 

func (s *PipeTargetCloudWatchLogsParameters) SetTimestamp(v string) *PipeTargetCloudWatchLogsParameters

SetTimestamp sets the Timestamp field's value.

func (PipeTargetCloudWatchLogsParameters) String 

func (s PipeTargetCloudWatchLogsParameters) 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 (*PipeTargetCloudWatchLogsParameters) Validate 

func (s *PipeTargetCloudWatchLogsParameters) Validate() error

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

type PipeTargetEcsTaskParameters 

type PipeTargetEcsTaskParameters 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 Amazon 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 with 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"`

	// The overrides that are associated with a task.
	Overrides *EcsTaskOverride `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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetEcsTaskParameters's
	// String and GoString methods.
	ReferenceId *string `type:"string" sensitive:"true"`

	// 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 parameters for using an Amazon ECS task as a target.

func (PipeTargetEcsTaskParameters) GoString 

func (s PipeTargetEcsTaskParameters) 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 (*PipeTargetEcsTaskParameters) SetCapacityProviderStrategy 

func (s *PipeTargetEcsTaskParameters) SetCapacityProviderStrategy(v []*CapacityProviderStrategyItem) *PipeTargetEcsTaskParameters

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*PipeTargetEcsTaskParameters) SetEnableECSManagedTags 

func (s *PipeTargetEcsTaskParameters) SetEnableECSManagedTags(v bool) *PipeTargetEcsTaskParameters

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*PipeTargetEcsTaskParameters) SetEnableExecuteCommand 

func (s *PipeTargetEcsTaskParameters) SetEnableExecuteCommand(v bool) *PipeTargetEcsTaskParameters

SetEnableExecuteCommand sets the EnableExecuteCommand field's value.

func (*PipeTargetEcsTaskParameters) SetGroup 

func (s *PipeTargetEcsTaskParameters) SetGroup(v string) *PipeTargetEcsTaskParameters

SetGroup sets the Group field's value.

func (*PipeTargetEcsTaskParameters) SetLaunchType 

func (s *PipeTargetEcsTaskParameters) SetLaunchType(v string) *PipeTargetEcsTaskParameters

SetLaunchType sets the LaunchType field's value.

func (*PipeTargetEcsTaskParameters) SetNetworkConfiguration 

func (s *PipeTargetEcsTaskParameters) SetNetworkConfiguration(v *NetworkConfiguration) *PipeTargetEcsTaskParameters

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*PipeTargetEcsTaskParameters) SetOverrides 

func (s *PipeTargetEcsTaskParameters) SetOverrides(v *EcsTaskOverride) *PipeTargetEcsTaskParameters

SetOverrides sets the Overrides field's value.

func (*PipeTargetEcsTaskParameters) SetPlacementConstraints 

func (s *PipeTargetEcsTaskParameters) SetPlacementConstraints(v []*PlacementConstraint) *PipeTargetEcsTaskParameters

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*PipeTargetEcsTaskParameters) SetPlacementStrategy 

func (s *PipeTargetEcsTaskParameters) SetPlacementStrategy(v []*PlacementStrategy) *PipeTargetEcsTaskParameters

SetPlacementStrategy sets the PlacementStrategy field's value.

func (*PipeTargetEcsTaskParameters) SetPlatformVersion 

func (s *PipeTargetEcsTaskParameters) SetPlatformVersion(v string) *PipeTargetEcsTaskParameters

SetPlatformVersion sets the PlatformVersion field's value.

func (*PipeTargetEcsTaskParameters) SetPropagateTags 

func (s *PipeTargetEcsTaskParameters) SetPropagateTags(v string) *PipeTargetEcsTaskParameters

SetPropagateTags sets the PropagateTags field's value.

func (*PipeTargetEcsTaskParameters) SetReferenceId 

func (s *PipeTargetEcsTaskParameters) SetReferenceId(v string) *PipeTargetEcsTaskParameters

SetReferenceId sets the ReferenceId field's value.

func (*PipeTargetEcsTaskParameters) SetTags 

func (s *PipeTargetEcsTaskParameters) SetTags(v []*Tag) *PipeTargetEcsTaskParameters

SetTags sets the Tags field's value.

func (*PipeTargetEcsTaskParameters) SetTaskCount 

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

SetTaskCount sets the TaskCount field's value.

func (*PipeTargetEcsTaskParameters) SetTaskDefinitionArn 

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

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (PipeTargetEcsTaskParameters) String 

func (s PipeTargetEcsTaskParameters) 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 (*PipeTargetEcsTaskParameters) Validate 

func (s *PipeTargetEcsTaskParameters) Validate() error

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

type PipeTargetEventBridgeEventBusParameters 

type PipeTargetEventBridgeEventBusParameters struct {

	// A free-form string, with a maximum of 128 characters, used to decide what
	// fields to expect in the event detail.
	//
	// DetailType is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetEventBridgeEventBusParameters's
	// String and GoString methods.
	DetailType *string `min:"1" type:"string" sensitive:"true"`

	// The URL subdomain of the endpoint. For example, if the URL for Endpoint is
	// https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
	//
	// EndpointId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetEventBridgeEventBusParameters's
	// String and GoString methods.
	EndpointId *string `min:"1" type:"string" sensitive:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetEventBridgeEventBusParameters's
	// String and GoString methods.
	Source *string `min:"1" type:"string" sensitive:"true"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The parameters for using an EventBridge event bus as a target.

func (PipeTargetEventBridgeEventBusParameters) GoString 

func (s PipeTargetEventBridgeEventBusParameters) 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 (*PipeTargetEventBridgeEventBusParameters) SetDetailType 

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

SetDetailType sets the DetailType field's value.

func (*PipeTargetEventBridgeEventBusParameters) SetEndpointId 

func (s *PipeTargetEventBridgeEventBusParameters) SetEndpointId(v string) *PipeTargetEventBridgeEventBusParameters

SetEndpointId sets the EndpointId field's value.

func (*PipeTargetEventBridgeEventBusParameters) SetResources 

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

SetResources sets the Resources field's value.

func (*PipeTargetEventBridgeEventBusParameters) SetSource 

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

SetSource sets the Source field's value.

func (*PipeTargetEventBridgeEventBusParameters) SetTime 

func (s *PipeTargetEventBridgeEventBusParameters) SetTime(v string) *PipeTargetEventBridgeEventBusParameters

SetTime sets the Time field's value.

func (PipeTargetEventBridgeEventBusParameters) String 

func (s PipeTargetEventBridgeEventBusParameters) 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 (*PipeTargetEventBridgeEventBusParameters) Validate 

func (s *PipeTargetEventBridgeEventBusParameters) Validate() error

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

type PipeTargetHttpParameters 

type PipeTargetHttpParameters 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.

func (PipeTargetHttpParameters) GoString 

func (s PipeTargetHttpParameters) 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 (*PipeTargetHttpParameters) SetHeaderParameters 

func (s *PipeTargetHttpParameters) SetHeaderParameters(v map[string]*string) *PipeTargetHttpParameters

SetHeaderParameters sets the HeaderParameters field's value.

func (*PipeTargetHttpParameters) SetPathParameterValues 

func (s *PipeTargetHttpParameters) SetPathParameterValues(v []*string) *PipeTargetHttpParameters

SetPathParameterValues sets the PathParameterValues field's value.

func (*PipeTargetHttpParameters) SetQueryStringParameters 

func (s *PipeTargetHttpParameters) SetQueryStringParameters(v map[string]*string) *PipeTargetHttpParameters

SetQueryStringParameters sets the QueryStringParameters field's value.

func (PipeTargetHttpParameters) String 

func (s PipeTargetHttpParameters) 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 PipeTargetKinesisStreamParameters 

type PipeTargetKinesisStreamParameters struct {

	// Determines which shard in the stream the data record is assigned to. Partition
	// keys are Unicode strings with a maximum length limit of 256 characters for
	// each key. Amazon Kinesis Data Streams uses the partition key as input to
	// a hash function that maps the partition key and associated data to a specific
	// shard. Specifically, an MD5 hash function is used to map partition keys to
	// 128-bit integer values and to map associated data records to shards. As a
	// result of this hashing mechanism, all data records with the same partition
	// key map to the same shard within the stream.
	//
	// PartitionKey is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetKinesisStreamParameters's
	// String and GoString methods.
	//
	// PartitionKey is a required field
	PartitionKey *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The parameters for using a Kinesis stream as a target.

func (PipeTargetKinesisStreamParameters) GoString 

func (s PipeTargetKinesisStreamParameters) 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 (*PipeTargetKinesisStreamParameters) SetPartitionKey 

func (s *PipeTargetKinesisStreamParameters) SetPartitionKey(v string) *PipeTargetKinesisStreamParameters

SetPartitionKey sets the PartitionKey field's value.

func (PipeTargetKinesisStreamParameters) String 

func (s PipeTargetKinesisStreamParameters) 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 (*PipeTargetKinesisStreamParameters) Validate 

func (s *PipeTargetKinesisStreamParameters) Validate() error

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

type PipeTargetLambdaFunctionParameters 

type PipeTargetLambdaFunctionParameters struct {

	// Specify whether to invoke the function synchronously or asynchronously.
	//
	//    * REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds
	//    to the RequestResponse option in the InvocationType parameter for the
	//    Lambda Invoke (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax)
	//    API.
	//
	//    * FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the Event
	//    option in the InvocationType parameter for the Lambda Invoke (https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax)
	//    API.
	//
	// For more information, see Invocation types (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation)
	// in the Amazon EventBridge User Guide.
	InvocationType *string `type:"string" enum:"PipeTargetInvocationType"`
	// contains filtered or unexported fields
}

The parameters for using a Lambda function as a target.

func (PipeTargetLambdaFunctionParameters) GoString 

func (s PipeTargetLambdaFunctionParameters) 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 (*PipeTargetLambdaFunctionParameters) SetInvocationType 

func (s *PipeTargetLambdaFunctionParameters) SetInvocationType(v string) *PipeTargetLambdaFunctionParameters

SetInvocationType sets the InvocationType field's value.

func (PipeTargetLambdaFunctionParameters) String 

func (s PipeTargetLambdaFunctionParameters) 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 PipeTargetParameters 

type PipeTargetParameters struct {

	// The parameters for using an Batch job as a target.
	BatchJobParameters *PipeTargetBatchJobParameters `type:"structure"`

	// The parameters for using an CloudWatch Logs log stream as a target.
	CloudWatchLogsParameters *PipeTargetCloudWatchLogsParameters `type:"structure"`

	// The parameters for using an Amazon ECS task as a target.
	EcsTaskParameters *PipeTargetEcsTaskParameters `type:"structure"`

	// The parameters for using an EventBridge event bus as a target.
	EventBridgeEventBusParameters *PipeTargetEventBridgeEventBusParameters `type:"structure"`

	// These are custom parameter to be used when the target is an API Gateway REST
	// APIs or EventBridge ApiDestinations.
	HttpParameters *PipeTargetHttpParameters `type:"structure"`

	// 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).
	//
	// To remove an input template, specify an empty string.
	//
	// InputTemplate is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetParameters's
	// String and GoString methods.
	InputTemplate *string `type:"string" sensitive:"true"`

	// The parameters for using a Kinesis stream as a target.
	KinesisStreamParameters *PipeTargetKinesisStreamParameters `type:"structure"`

	// The parameters for using a Lambda function as a target.
	LambdaFunctionParameters *PipeTargetLambdaFunctionParameters `type:"structure"`

	// These are custom parameters to be used when the target is a Amazon Redshift
	// cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
	RedshiftDataParameters *PipeTargetRedshiftDataParameters `type:"structure"`

	// The parameters for using a SageMaker pipeline as a target.
	SageMakerPipelineParameters *PipeTargetSageMakerPipelineParameters `type:"structure"`

	// The parameters for using a Amazon SQS stream as a target.
	SqsQueueParameters *PipeTargetSqsQueueParameters `type:"structure"`

	// The parameters for using a Step Functions state machine as a target.
	StepFunctionStateMachineParameters *PipeTargetStateMachineParameters `type:"structure"`
	// contains filtered or unexported fields
}

The parameters required to set up a target for your pipe.

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) in the Amazon EventBridge User Guide.

func (PipeTargetParameters) GoString 

func (s PipeTargetParameters) 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 (*PipeTargetParameters) SetBatchJobParameters 

func (s *PipeTargetParameters) SetBatchJobParameters(v *PipeTargetBatchJobParameters) *PipeTargetParameters

SetBatchJobParameters sets the BatchJobParameters field's value.

func (*PipeTargetParameters) SetCloudWatchLogsParameters 

func (s *PipeTargetParameters) SetCloudWatchLogsParameters(v *PipeTargetCloudWatchLogsParameters) *PipeTargetParameters

SetCloudWatchLogsParameters sets the CloudWatchLogsParameters field's value.

func (*PipeTargetParameters) SetEcsTaskParameters 

func (s *PipeTargetParameters) SetEcsTaskParameters(v *PipeTargetEcsTaskParameters) *PipeTargetParameters

SetEcsTaskParameters sets the EcsTaskParameters field's value.

func (*PipeTargetParameters) SetEventBridgeEventBusParameters 

func (s *PipeTargetParameters) SetEventBridgeEventBusParameters(v *PipeTargetEventBridgeEventBusParameters) *PipeTargetParameters

SetEventBridgeEventBusParameters sets the EventBridgeEventBusParameters field's value.

func (*PipeTargetParameters) SetHttpParameters 

func (s *PipeTargetParameters) SetHttpParameters(v *PipeTargetHttpParameters) *PipeTargetParameters

SetHttpParameters sets the HttpParameters field's value.

func (*PipeTargetParameters) SetInputTemplate 

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

SetInputTemplate sets the InputTemplate field's value.

func (*PipeTargetParameters) SetKinesisStreamParameters 

func (s *PipeTargetParameters) SetKinesisStreamParameters(v *PipeTargetKinesisStreamParameters) *PipeTargetParameters

SetKinesisStreamParameters sets the KinesisStreamParameters field's value.

func (*PipeTargetParameters) SetLambdaFunctionParameters 

func (s *PipeTargetParameters) SetLambdaFunctionParameters(v *PipeTargetLambdaFunctionParameters) *PipeTargetParameters

SetLambdaFunctionParameters sets the LambdaFunctionParameters field's value.

func (*PipeTargetParameters) SetRedshiftDataParameters 

func (s *PipeTargetParameters) SetRedshiftDataParameters(v *PipeTargetRedshiftDataParameters) *PipeTargetParameters

SetRedshiftDataParameters sets the RedshiftDataParameters field's value.

func (*PipeTargetParameters) SetSageMakerPipelineParameters 

func (s *PipeTargetParameters) SetSageMakerPipelineParameters(v *PipeTargetSageMakerPipelineParameters) *PipeTargetParameters

SetSageMakerPipelineParameters sets the SageMakerPipelineParameters field's value.

func (*PipeTargetParameters) SetSqsQueueParameters 

func (s *PipeTargetParameters) SetSqsQueueParameters(v *PipeTargetSqsQueueParameters) *PipeTargetParameters

SetSqsQueueParameters sets the SqsQueueParameters field's value.

func (*PipeTargetParameters) SetStepFunctionStateMachineParameters 

func (s *PipeTargetParameters) SetStepFunctionStateMachineParameters(v *PipeTargetStateMachineParameters) *PipeTargetParameters

SetStepFunctionStateMachineParameters sets the StepFunctionStateMachineParameters field's value.

func (PipeTargetParameters) String 

func (s PipeTargetParameters) 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 (*PipeTargetParameters) Validate 

func (s *PipeTargetParameters) Validate() error

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

type PipeTargetRedshiftDataParameters 

type PipeTargetRedshiftDataParameters struct {

	// The name of the database. Required when authenticating using temporary credentials.
	//
	// Database is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetRedshiftDataParameters's
	// String and GoString methods.
	//
	// Database is a required field
	Database *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The database user name. Required when authenticating using temporary credentials.
	//
	// DbUser is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetRedshiftDataParameters's
	// String and GoString methods.
	DbUser *string `min:"1" type:"string" sensitive:"true"`

	// The name or ARN of the secret that enables access to the database. Required
	// when authenticating using Secrets Manager.
	SecretManagerArn *string `min:"1" type:"string"`

	// The SQL statement text to run.
	//
	// Sqls is a required field
	Sqls []*string `min:"1" type:"list" required:"true"`

	// The name of the SQL statement. You can name the SQL statement when you create
	// it to identify the query.
	//
	// StatementName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetRedshiftDataParameters's
	// String and GoString methods.
	StatementName *string `min:"1" type:"string" sensitive:"true"`

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

func (PipeTargetRedshiftDataParameters) GoString 

func (s PipeTargetRedshiftDataParameters) 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 (*PipeTargetRedshiftDataParameters) SetDatabase 

func (s *PipeTargetRedshiftDataParameters) SetDatabase(v string) *PipeTargetRedshiftDataParameters

SetDatabase sets the Database field's value.

func (*PipeTargetRedshiftDataParameters) SetDbUser 

func (s *PipeTargetRedshiftDataParameters) SetDbUser(v string) *PipeTargetRedshiftDataParameters

SetDbUser sets the DbUser field's value.

func (*PipeTargetRedshiftDataParameters) SetSecretManagerArn 

func (s *PipeTargetRedshiftDataParameters) SetSecretManagerArn(v string) *PipeTargetRedshiftDataParameters

SetSecretManagerArn sets the SecretManagerArn field's value.

func (*PipeTargetRedshiftDataParameters) SetSqls 

func (s *PipeTargetRedshiftDataParameters) SetSqls(v []*string) *PipeTargetRedshiftDataParameters

SetSqls sets the Sqls field's value.

func (*PipeTargetRedshiftDataParameters) SetStatementName 

func (s *PipeTargetRedshiftDataParameters) SetStatementName(v string) *PipeTargetRedshiftDataParameters

SetStatementName sets the StatementName field's value.

func (*PipeTargetRedshiftDataParameters) SetWithEvent 

func (s *PipeTargetRedshiftDataParameters) SetWithEvent(v bool) *PipeTargetRedshiftDataParameters

SetWithEvent sets the WithEvent field's value.

func (PipeTargetRedshiftDataParameters) String 

func (s PipeTargetRedshiftDataParameters) 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 (*PipeTargetRedshiftDataParameters) Validate 

func (s *PipeTargetRedshiftDataParameters) Validate() error

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

type PipeTargetSageMakerPipelineParameters 

type PipeTargetSageMakerPipelineParameters struct {

	// List of Parameter names and values for SageMaker Model Building Pipeline
	// execution.
	PipelineParameterList []*SageMakerPipelineParameter `type:"list"`
	// contains filtered or unexported fields
}

The parameters for using a SageMaker pipeline as a target.

func (PipeTargetSageMakerPipelineParameters) GoString 

func (s PipeTargetSageMakerPipelineParameters) 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 (*PipeTargetSageMakerPipelineParameters) SetPipelineParameterList 

func (s *PipeTargetSageMakerPipelineParameters) SetPipelineParameterList(v []*SageMakerPipelineParameter) *PipeTargetSageMakerPipelineParameters

SetPipelineParameterList sets the PipelineParameterList field's value.

func (PipeTargetSageMakerPipelineParameters) String 

func (s PipeTargetSageMakerPipelineParameters) 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 (*PipeTargetSageMakerPipelineParameters) Validate 

func (s *PipeTargetSageMakerPipelineParameters) Validate() error

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

type PipeTargetSqsQueueParameters 

type PipeTargetSqsQueueParameters struct {

	// This parameter applies only to FIFO (first-in-first-out) queues.
	//
	// The token used for deduplication of sent messages.
	//
	// MessageDeduplicationId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetSqsQueueParameters's
	// String and GoString methods.
	MessageDeduplicationId *string `type:"string" sensitive:"true"`

	// The FIFO message group ID to use as the target.
	//
	// MessageGroupId is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PipeTargetSqsQueueParameters's
	// String and GoString methods.
	MessageGroupId *string `type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

The parameters for using a Amazon SQS stream as a target.

func (PipeTargetSqsQueueParameters) GoString 

func (s PipeTargetSqsQueueParameters) 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 (*PipeTargetSqsQueueParameters) SetMessageDeduplicationId 

func (s *PipeTargetSqsQueueParameters) SetMessageDeduplicationId(v string) *PipeTargetSqsQueueParameters

SetMessageDeduplicationId sets the MessageDeduplicationId field's value.

func (*PipeTargetSqsQueueParameters) SetMessageGroupId 

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

SetMessageGroupId sets the MessageGroupId field's value.

func (PipeTargetSqsQueueParameters) String 

func (s PipeTargetSqsQueueParameters) 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 PipeTargetStateMachineParameters 

type PipeTargetStateMachineParameters struct {

	// Specify whether to invoke the Step Functions state machine synchronously
	// or asynchronously.
	//
	//    * REQUEST_RESPONSE (default) - Invoke synchronously. For more information,
	//    see StartSyncExecution (https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartSyncExecution.html)
	//    in the Step Functions API Reference. REQUEST_RESPONSE is not supported
	//    for STANDARD state machine workflows.
	//
	//    * FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution
	//    (https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html)
	//    in the Step Functions API Reference.
	//
	// For more information, see Invocation types (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-invocation)
	// in the Amazon EventBridge User Guide.
	InvocationType *string `type:"string" enum:"PipeTargetInvocationType"`
	// contains filtered or unexported fields
}

The parameters for using a Step Functions state machine as a target.

func (PipeTargetStateMachineParameters) GoString 

func (s PipeTargetStateMachineParameters) 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 (*PipeTargetStateMachineParameters) SetInvocationType 

func (s *PipeTargetStateMachineParameters) SetInvocationType(v string) *PipeTargetStateMachineParameters

SetInvocationType sets the InvocationType field's value.

func (PipeTargetStateMachineParameters) String 

func (s PipeTargetStateMachineParameters) 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 Pipes 

type Pipes struct {
	*client.Client
}

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

Pipes 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) *Pipes

New creates a new instance of the Pipes 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 Pipes client from just a session.
svc := pipes.New(mySession)

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

func (*Pipes) CreatePipe 

func (c *Pipes) CreatePipe(input *CreatePipeInput) (*CreatePipeOutput, error)

CreatePipe API operation for Amazon EventBridge Pipes.

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration 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 EventBridge Pipes's API operation CreatePipe for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • ThrottlingException An action was throttled.

  • NotFoundException An entity that you specified does not exist.

  • ConflictException An action you attempted resulted in an exception.

  • ServiceQuotaExceededException A quota has been exceeded.

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

func (*Pipes) CreatePipeRequest 

func (c *Pipes) CreatePipeRequest(input *CreatePipeInput) (req *request.Request, output *CreatePipeOutput)

CreatePipeRequest generates a "aws/request.Request" representing the client's request for the CreatePipe 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 CreatePipe for more information on using the CreatePipe 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 CreatePipeRequest method.
req, resp := client.CreatePipeRequest(params)

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

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

func (*Pipes) CreatePipeWithContext 

func (c *Pipes) CreatePipeWithContext(ctx aws.Context, input *CreatePipeInput, opts ...request.Option) (*CreatePipeOutput, error)

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

See CreatePipe 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 (*Pipes) DeletePipe 

func (c *Pipes) DeletePipe(input *DeletePipeInput) (*DeletePipeOutput, error)

DeletePipe API operation for Amazon EventBridge Pipes.

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) in the Amazon EventBridge User Guide.

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 EventBridge Pipes's API operation DeletePipe for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • ThrottlingException An action was throttled.

  • NotFoundException An entity that you specified does not exist.

  • ConflictException An action you attempted resulted in an exception.

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

func (*Pipes) DeletePipeRequest 

func (c *Pipes) DeletePipeRequest(input *DeletePipeInput) (req *request.Request, output *DeletePipeOutput)

DeletePipeRequest generates a "aws/request.Request" representing the client's request for the DeletePipe 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 DeletePipe for more information on using the DeletePipe 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 DeletePipeRequest method.
req, resp := client.DeletePipeRequest(params)

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

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

func (*Pipes) DeletePipeWithContext 

func (c *Pipes) DeletePipeWithContext(ctx aws.Context, input *DeletePipeInput, opts ...request.Option) (*DeletePipeOutput, error)

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

See DeletePipe 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 (*Pipes) DescribePipe 

func (c *Pipes) DescribePipe(input *DescribePipeInput) (*DescribePipeOutput, error)

DescribePipe API operation for Amazon EventBridge Pipes.

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) in the Amazon EventBridge User Guide.

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 EventBridge Pipes's API operation DescribePipe for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • ThrottlingException An action was throttled.

  • NotFoundException An entity that you specified does not exist.

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

func (*Pipes) DescribePipeRequest 

func (c *Pipes) DescribePipeRequest(input *DescribePipeInput) (req *request.Request, output *DescribePipeOutput)

DescribePipeRequest generates a "aws/request.Request" representing the client's request for the DescribePipe 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 DescribePipe for more information on using the DescribePipe 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 DescribePipeRequest method.
req, resp := client.DescribePipeRequest(params)

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

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

func (*Pipes) DescribePipeWithContext 

func (c *Pipes) DescribePipeWithContext(ctx aws.Context, input *DescribePipeInput, opts ...request.Option) (*DescribePipeOutput, error)

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

See DescribePipe 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 (*Pipes) ListPipes 

func (c *Pipes) ListPipes(input *ListPipesInput) (*ListPipesOutput, error)

ListPipes API operation for Amazon EventBridge Pipes.

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) in the Amazon EventBridge User Guide.

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 EventBridge Pipes's API operation ListPipes for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • ThrottlingException An action was throttled.

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

func (*Pipes) ListPipesPages 

func (c *Pipes) ListPipesPages(input *ListPipesInput, fn func(*ListPipesOutput, bool) bool) error

ListPipesPages iterates over the pages of a ListPipes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPipes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPipes operation.
pageNum := 0
err := client.ListPipesPages(params,
    func(page *pipes.ListPipesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Pipes) ListPipesPagesWithContext 

func (c *Pipes) ListPipesPagesWithContext(ctx aws.Context, input *ListPipesInput, fn func(*ListPipesOutput, bool) bool, opts ...request.Option) error

ListPipesPagesWithContext same as ListPipesPages except it takes a Context and allows setting request options on the pages.

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 (*Pipes) ListPipesRequest 

func (c *Pipes) ListPipesRequest(input *ListPipesInput) (req *request.Request, output *ListPipesOutput)

ListPipesRequest generates a "aws/request.Request" representing the client's request for the ListPipes 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 ListPipes for more information on using the ListPipes 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 ListPipesRequest method.
req, resp := client.ListPipesRequest(params)

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

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

func (*Pipes) ListPipesWithContext 

func (c *Pipes) ListPipesWithContext(ctx aws.Context, input *ListPipesInput, opts ...request.Option) (*ListPipesOutput, error)

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

See ListPipes 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 (*Pipes) ListTagsForResource 

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

ListTagsForResource API operation for Amazon EventBridge Pipes.

Displays the tags associated with a pipe.

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 EventBridge Pipes's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • NotFoundException An entity that you specified does not exist.

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

func (*Pipes) ListTagsForResourceRequest 

func (c *Pipes) 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/pipes-2015-10-07/ListTagsForResource

func (*Pipes) ListTagsForResourceWithContext 

func (c *Pipes) 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 (*Pipes) StartPipe 

func (c *Pipes) StartPipe(input *StartPipeInput) (*StartPipeOutput, error)

StartPipe API operation for Amazon EventBridge Pipes.

Start an existing pipe.

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 EventBridge Pipes's API operation StartPipe for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • ThrottlingException An action was throttled.

  • NotFoundException An entity that you specified does not exist.

  • ConflictException An action you attempted resulted in an exception.

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

func (*Pipes) StartPipeRequest 

func (c *Pipes) StartPipeRequest(input *StartPipeInput) (req *request.Request, output *StartPipeOutput)

StartPipeRequest generates a "aws/request.Request" representing the client's request for the StartPipe 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 StartPipe for more information on using the StartPipe 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 StartPipeRequest method.
req, resp := client.StartPipeRequest(params)

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

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

func (*Pipes) StartPipeWithContext 

func (c *Pipes) StartPipeWithContext(ctx aws.Context, input *StartPipeInput, opts ...request.Option) (*StartPipeOutput, error)

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

See StartPipe 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 (*Pipes) StopPipe 

func (c *Pipes) StopPipe(input *StopPipeInput) (*StopPipeOutput, error)

StopPipe API operation for Amazon EventBridge Pipes.

Stop an existing pipe.

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 EventBridge Pipes's API operation StopPipe for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • ThrottlingException An action was throttled.

  • NotFoundException An entity that you specified does not exist.

  • ConflictException An action you attempted resulted in an exception.

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

func (*Pipes) StopPipeRequest 

func (c *Pipes) StopPipeRequest(input *StopPipeInput) (req *request.Request, output *StopPipeOutput)

StopPipeRequest generates a "aws/request.Request" representing the client's request for the StopPipe 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 StopPipe for more information on using the StopPipe 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 StopPipeRequest method.
req, resp := client.StopPipeRequest(params)

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

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

func (*Pipes) StopPipeWithContext 

func (c *Pipes) StopPipeWithContext(ctx aws.Context, input *StopPipeInput, opts ...request.Option) (*StopPipeOutput, error)

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

See StopPipe 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 (*Pipes) TagResource 

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

TagResource API operation for Amazon EventBridge Pipes.

Assigns one or more tags (key-value pairs) to the specified pipe. 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.

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 pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag.

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

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 EventBridge Pipes's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • NotFoundException An entity that you specified does not exist.

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

func (*Pipes) TagResourceRequest 

func (c *Pipes) 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/pipes-2015-10-07/TagResource

func (*Pipes) TagResourceWithContext 

func (c *Pipes) 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 (*Pipes) UntagResource 

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

UntagResource API operation for Amazon EventBridge Pipes.

Removes one or more tags from the specified pipes.

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 EventBridge Pipes's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • NotFoundException An entity that you specified does not exist.

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

func (*Pipes) UntagResourceRequest 

func (c *Pipes) 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/pipes-2015-10-07/UntagResource

func (*Pipes) UntagResourceWithContext 

func (c *Pipes) 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 (*Pipes) UpdatePipe 

func (c *Pipes) UpdatePipe(input *UpdatePipeInput) (*UpdatePipeOutput, error)

UpdatePipe API operation for Amazon EventBridge Pipes.

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.

For more information about pipes, see Amazon EventBridge Pipes (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html) in the Amazon EventBridge User Guide.

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 EventBridge Pipes's API operation UpdatePipe for usage and error information.

Returned Error Types:

  • InternalException This exception occurs due to unexpected causes.

  • ValidationException Indicates that an error has occurred while performing a validate operation.

  • ThrottlingException An action was throttled.

  • NotFoundException An entity that you specified does not exist.

  • ConflictException An action you attempted resulted in an exception.

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

func (*Pipes) UpdatePipeRequest 

func (c *Pipes) UpdatePipeRequest(input *UpdatePipeInput) (req *request.Request, output *UpdatePipeOutput)

UpdatePipeRequest generates a "aws/request.Request" representing the client's request for the UpdatePipe 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 UpdatePipe for more information on using the UpdatePipe 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 UpdatePipeRequest method.
req, resp := client.UpdatePipeRequest(params)

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

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

func (*Pipes) UpdatePipeWithContext 

func (c *Pipes) UpdatePipeWithContext(ctx aws.Context, input *UpdatePipeInput, opts ...request.Option) (*UpdatePipeOutput, error)

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

See UpdatePipe 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 PlacementConstraint 

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlacementConstraint's
	// String and GoString methods.
	Expression *string `locationName:"expression" type:"string" sensitive:"true"`

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

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 

func (s *PlacementConstraint) SetExpression(v string) *PlacementConstraint

SetExpression sets the Expression field's value.

func (*PlacementConstraint) SetType 

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

SetType sets the Type field's value.

func (PlacementConstraint) String 

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 

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PlacementStrategy's
	// String and GoString methods.
	Field *string `locationName:"field" type:"string" sensitive:"true"`

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

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 

func (s *PlacementStrategy) SetField(v string) *PlacementStrategy

SetField sets the Field field's value.

func (*PlacementStrategy) SetType 

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

SetType sets the Type field's value.

func (PlacementStrategy) String 

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 S3LogDestination added in v1.47.11 

type S3LogDestination struct {

	// The name of the Amazon S3 bucket to which EventBridge delivers the log records
	// for the pipe.
	BucketName *string `type:"string"`

	// The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge
	// delivers the log records for the pipe.
	BucketOwner *string `type:"string"`

	// The format EventBridge uses for the log records.
	//
	//    * json: JSON
	//
	//    * plain: Plain text
	//
	//    * w3c: W3C extended logging file format (https://www.w3.org/TR/WD-logfile)
	OutputFormat *string `type:"string" enum:"S3OutputFormat"`

	// The prefix text with which to begin Amazon S3 log object names.
	//
	// For more information, see Organizing objects using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html)
	// in the Amazon Simple Storage Service User Guide.
	Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

The Amazon S3 logging configuration settings for the pipe.

func (S3LogDestination) GoString added in v1.47.11 

func (s S3LogDestination) 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 (*S3LogDestination) SetBucketName added in v1.47.11 

func (s *S3LogDestination) SetBucketName(v string) *S3LogDestination

SetBucketName sets the BucketName field's value.

func (*S3LogDestination) SetBucketOwner added in v1.47.11 

func (s *S3LogDestination) SetBucketOwner(v string) *S3LogDestination

SetBucketOwner sets the BucketOwner field's value.

func (*S3LogDestination) SetOutputFormat added in v1.47.11 

func (s *S3LogDestination) SetOutputFormat(v string) *S3LogDestination

SetOutputFormat sets the OutputFormat field's value.

func (*S3LogDestination) SetPrefix added in v1.47.11 

func (s *S3LogDestination) SetPrefix(v string) *S3LogDestination

SetPrefix sets the Prefix field's value.

func (S3LogDestination) String added in v1.47.11 

func (s S3LogDestination) 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 S3LogDestinationParameters added in v1.47.11 

type S3LogDestinationParameters struct {

	// Specifies the name of the Amazon S3 bucket to which EventBridge delivers
	// the log records for the pipe.
	//
	// BucketName is a required field
	BucketName *string `min:"3" type:"string" required:"true"`

	// Specifies the Amazon Web Services account that owns the Amazon S3 bucket
	// to which EventBridge delivers the log records for the pipe.
	//
	// BucketOwner is a required field
	BucketOwner *string `type:"string" required:"true"`

	// How EventBridge should format the log records.
	//
	//    * json: JSON
	//
	//    * plain: Plain text
	//
	//    * w3c: W3C extended logging file format (https://www.w3.org/TR/WD-logfile)
	OutputFormat *string `type:"string" enum:"S3OutputFormat"`

	// Specifies any prefix text with which to begin Amazon S3 log object names.
	//
	// You can use prefixes to organize the data that you store in Amazon S3 buckets.
	// A prefix is a string of characters at the beginning of the object key name.
	// A prefix can be any length, subject to the maximum length of the object key
	// name (1,024 bytes). For more information, see Organizing objects using prefixes
	// (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html)
	// in the Amazon Simple Storage Service User Guide.
	Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

The Amazon S3 logging configuration settings for the pipe.

func (S3LogDestinationParameters) GoString added in v1.47.11 

func (s S3LogDestinationParameters) 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 (*S3LogDestinationParameters) SetBucketName added in v1.47.11 

func (s *S3LogDestinationParameters) SetBucketName(v string) *S3LogDestinationParameters

SetBucketName sets the BucketName field's value.

func (*S3LogDestinationParameters) SetBucketOwner added in v1.47.11 

func (s *S3LogDestinationParameters) SetBucketOwner(v string) *S3LogDestinationParameters

SetBucketOwner sets the BucketOwner field's value.

func (*S3LogDestinationParameters) SetOutputFormat added in v1.47.11 

func (s *S3LogDestinationParameters) SetOutputFormat(v string) *S3LogDestinationParameters

SetOutputFormat sets the OutputFormat field's value.

func (*S3LogDestinationParameters) SetPrefix added in v1.47.11 

func (s *S3LogDestinationParameters) SetPrefix(v string) *S3LogDestinationParameters

SetPrefix sets the Prefix field's value.

func (S3LogDestinationParameters) String added in v1.47.11 

func (s S3LogDestinationParameters) 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 (*S3LogDestinationParameters) Validate added in v1.47.11 

func (s *S3LogDestinationParameters) Validate() error

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

type SageMakerPipelineParameter 

type SageMakerPipelineParameter struct {

	// Name of parameter to start execution of a SageMaker Model Building Pipeline.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SageMakerPipelineParameter's
	// String and GoString methods.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// Value of parameter to start execution of a SageMaker Model Building Pipeline.
	//
	// Value is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by SageMakerPipelineParameter's
	// String and GoString methods.
	//
	// Value is a required field
	Value *string `type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.

func (SageMakerPipelineParameter) GoString 

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 

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

SetName sets the Name field's value.

func (*SageMakerPipelineParameter) SetValue 

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

SetValue sets the Value field's value.

func (SageMakerPipelineParameter) String 

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 

func (s *SageMakerPipelineParameter) Validate() error

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

type SelfManagedKafkaAccessConfigurationCredentials 

type SelfManagedKafkaAccessConfigurationCredentials struct {

	// The ARN of the Secrets Manager secret.
	BasicAuth *string `min:"1" type:"string"`

	// The ARN of the Secrets Manager secret.
	ClientCertificateTlsAuth *string `min:"1" type:"string"`

	// The ARN of the Secrets Manager secret.
	SaslScram256Auth *string `min:"1" type:"string"`

	// The ARN of the Secrets Manager secret.
	SaslScram512Auth *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The Secrets Manager secret that stores your stream credentials.

func (SelfManagedKafkaAccessConfigurationCredentials) GoString 

func (s SelfManagedKafkaAccessConfigurationCredentials) 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 (*SelfManagedKafkaAccessConfigurationCredentials) SetBasicAuth 

func (s *SelfManagedKafkaAccessConfigurationCredentials) SetBasicAuth(v string) *SelfManagedKafkaAccessConfigurationCredentials

SetBasicAuth sets the BasicAuth field's value.

func (*SelfManagedKafkaAccessConfigurationCredentials) SetClientCertificateTlsAuth 

func (s *SelfManagedKafkaAccessConfigurationCredentials) SetClientCertificateTlsAuth(v string) *SelfManagedKafkaAccessConfigurationCredentials

SetClientCertificateTlsAuth sets the ClientCertificateTlsAuth field's value.

func (*SelfManagedKafkaAccessConfigurationCredentials) SetSaslScram256Auth 

func (s *SelfManagedKafkaAccessConfigurationCredentials) SetSaslScram256Auth(v string) *SelfManagedKafkaAccessConfigurationCredentials

SetSaslScram256Auth sets the SaslScram256Auth field's value.

func (*SelfManagedKafkaAccessConfigurationCredentials) SetSaslScram512Auth 

func (s *SelfManagedKafkaAccessConfigurationCredentials) SetSaslScram512Auth(v string) *SelfManagedKafkaAccessConfigurationCredentials

SetSaslScram512Auth sets the SaslScram512Auth field's value.

func (SelfManagedKafkaAccessConfigurationCredentials) String 

func (s SelfManagedKafkaAccessConfigurationCredentials) 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 (*SelfManagedKafkaAccessConfigurationCredentials) Validate 

func (s *SelfManagedKafkaAccessConfigurationCredentials) Validate() error

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

type SelfManagedKafkaAccessConfigurationVpc 

type SelfManagedKafkaAccessConfigurationVpc struct {

	// Specifies the security groups associated with the stream. 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.
	SecurityGroup []*string `type:"list"`

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

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

func (SelfManagedKafkaAccessConfigurationVpc) GoString 

func (s SelfManagedKafkaAccessConfigurationVpc) 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 (*SelfManagedKafkaAccessConfigurationVpc) SetSecurityGroup 

func (s *SelfManagedKafkaAccessConfigurationVpc) SetSecurityGroup(v []*string) *SelfManagedKafkaAccessConfigurationVpc

SetSecurityGroup sets the SecurityGroup field's value.

func (*SelfManagedKafkaAccessConfigurationVpc) SetSubnets 

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

SetSubnets sets the Subnets field's value.

func (SelfManagedKafkaAccessConfigurationVpc) String 

func (s SelfManagedKafkaAccessConfigurationVpc) 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 ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The identifier of the quota that caused the exception.
	//
	// QuotaCode is a required field
	QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"`

	// The ID of the resource that caused the exception.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of resource that caused the exception.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`

	// The identifier of the service that caused the exception.
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A quota has been exceeded.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) 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 (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) 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 StartPipeInput 

type StartPipeInput struct {

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

func (StartPipeInput) GoString 

func (s StartPipeInput) 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 (*StartPipeInput) SetName 

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

SetName sets the Name field's value.

func (StartPipeInput) String 

func (s StartPipeInput) 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 (*StartPipeInput) Validate 

func (s *StartPipeInput) Validate() error

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

type StartPipeOutput 

type StartPipeOutput struct {

	// The ARN of the pipe.
	Arn *string `min:"1" type:"string"`

	// The time the pipe was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state the pipe is in.
	CurrentState *string `type:"string" enum:"PipeState"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeState"`

	// When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)
	// (YYYY-MM-DDThh:mm:ss.sTZD).
	LastModifiedTime *time.Time `type:"timestamp"`

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

func (StartPipeOutput) GoString 

func (s StartPipeOutput) 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 (*StartPipeOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*StartPipeOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*StartPipeOutput) SetCurrentState 

func (s *StartPipeOutput) SetCurrentState(v string) *StartPipeOutput

SetCurrentState sets the CurrentState field's value.

func (*StartPipeOutput) SetDesiredState 

func (s *StartPipeOutput) SetDesiredState(v string) *StartPipeOutput

SetDesiredState sets the DesiredState field's value.

func (*StartPipeOutput) SetLastModifiedTime 

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

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*StartPipeOutput) SetName 

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

SetName sets the Name field's value.

func (StartPipeOutput) String 

func (s StartPipeOutput) 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 StopPipeInput 

type StopPipeInput struct {

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

func (StopPipeInput) GoString 

func (s StopPipeInput) 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 (*StopPipeInput) SetName 

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

SetName sets the Name field's value.

func (StopPipeInput) String 

func (s StopPipeInput) 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 (*StopPipeInput) Validate 

func (s *StopPipeInput) Validate() error

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

type StopPipeOutput 

type StopPipeOutput struct {

	// The ARN of the pipe.
	Arn *string `min:"1" type:"string"`

	// The time the pipe was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state the pipe is in.
	CurrentState *string `type:"string" enum:"PipeState"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeState"`

	// When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)
	// (YYYY-MM-DDThh:mm:ss.sTZD).
	LastModifiedTime *time.Time `type:"timestamp"`

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

func (StopPipeOutput) GoString 

func (s StopPipeOutput) 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 (*StopPipeOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*StopPipeOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*StopPipeOutput) SetCurrentState 

func (s *StopPipeOutput) SetCurrentState(v string) *StopPipeOutput

SetCurrentState sets the CurrentState field's value.

func (*StopPipeOutput) SetDesiredState 

func (s *StopPipeOutput) SetDesiredState(v string) *StopPipeOutput

SetDesiredState sets the DesiredState field's value.

func (*StopPipeOutput) SetLastModifiedTime 

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

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*StopPipeOutput) SetName 

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

SetName sets the Name field's value.

func (StopPipeOutput) String 

func (s StopPipeOutput) 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 

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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Tag's
	// String and GoString methods.
	//
	// Value is a required field
	Value *string `type:"string" required:"true" sensitive:"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 

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 

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

SetKey sets the Key field's value.

func (*Tag) SetValue 

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

SetValue sets the Value field's value.

func (Tag) String 

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 

func (s *Tag) Validate() error

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

type TagResourceInput 

type TagResourceInput struct {

	// The ARN of the pipe.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The list of key-value pairs associated with the pipe.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

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 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

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 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

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 

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 ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The identifier of the quota that caused the exception.
	QuotaCode *string `locationName:"quotaCode" type:"string"`

	// The number of seconds to wait before retrying the action that caused the
	// exception.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`

	// The identifier of the service that caused the exception.
	ServiceCode *string `locationName:"serviceCode" type:"string"`
	// contains filtered or unexported fields
}

An action was throttled.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) 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 (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) 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 

type UntagResourceInput struct {

	// The ARN of the pipe.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

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

func (UntagResourceInput) GoString 

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 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

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 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

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 

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 UpdatePipeInput 

type UpdatePipeInput struct {

	// A description of the pipe.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdatePipeInput's
	// String and GoString methods.
	Description *string `type:"string" sensitive:"true"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeState"`

	// The ARN of the enrichment resource.
	Enrichment *string `type:"string"`

	// The parameters required to set up enrichment on your pipe.
	EnrichmentParameters *PipeEnrichmentParameters `type:"structure"`

	// The logging configuration settings for the pipe.
	LogConfiguration *PipeLogConfigurationParameters `type:"structure"`

	// The name of the pipe.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`

	// The ARN of the role that allows the pipe to send data to the target.
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`

	// The parameters required to set up a source for your pipe.
	SourceParameters *UpdatePipeSourceParameters `type:"structure"`

	// The ARN of the target resource.
	Target *string `min:"1" type:"string"`

	// The parameters required to set up a target for your pipe.
	//
	// For more information about pipe target parameters, including how to use dynamic
	// path parameters, see Target parameters (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html)
	// in the Amazon EventBridge User Guide.
	TargetParameters *PipeTargetParameters `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdatePipeInput) GoString 

func (s UpdatePipeInput) 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 (*UpdatePipeInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdatePipeInput) SetDesiredState 

func (s *UpdatePipeInput) SetDesiredState(v string) *UpdatePipeInput

SetDesiredState sets the DesiredState field's value.

func (*UpdatePipeInput) SetEnrichment 

func (s *UpdatePipeInput) SetEnrichment(v string) *UpdatePipeInput

SetEnrichment sets the Enrichment field's value.

func (*UpdatePipeInput) SetEnrichmentParameters 

func (s *UpdatePipeInput) SetEnrichmentParameters(v *PipeEnrichmentParameters) *UpdatePipeInput

SetEnrichmentParameters sets the EnrichmentParameters field's value.

func (*UpdatePipeInput) SetLogConfiguration added in v1.47.11 

func (s *UpdatePipeInput) SetLogConfiguration(v *PipeLogConfigurationParameters) *UpdatePipeInput

SetLogConfiguration sets the LogConfiguration field's value.

func (*UpdatePipeInput) SetName 

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

SetName sets the Name field's value.

func (*UpdatePipeInput) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*UpdatePipeInput) SetSourceParameters 

func (s *UpdatePipeInput) SetSourceParameters(v *UpdatePipeSourceParameters) *UpdatePipeInput

SetSourceParameters sets the SourceParameters field's value.

func (*UpdatePipeInput) SetTarget 

func (s *UpdatePipeInput) SetTarget(v string) *UpdatePipeInput

SetTarget sets the Target field's value.

func (*UpdatePipeInput) SetTargetParameters 

func (s *UpdatePipeInput) SetTargetParameters(v *PipeTargetParameters) *UpdatePipeInput

SetTargetParameters sets the TargetParameters field's value.

func (UpdatePipeInput) String 

func (s UpdatePipeInput) 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 (*UpdatePipeInput) Validate 

func (s *UpdatePipeInput) Validate() error

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

type UpdatePipeOutput 

type UpdatePipeOutput struct {

	// The ARN of the pipe.
	Arn *string `min:"1" type:"string"`

	// The time the pipe was created.
	CreationTime *time.Time `type:"timestamp"`

	// The state the pipe is in.
	CurrentState *string `type:"string" enum:"PipeState"`

	// The state the pipe should be in.
	DesiredState *string `type:"string" enum:"RequestedPipeState"`

	// When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)
	// (YYYY-MM-DDThh:mm:ss.sTZD).
	LastModifiedTime *time.Time `type:"timestamp"`

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

func (UpdatePipeOutput) GoString 

func (s UpdatePipeOutput) 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 (*UpdatePipeOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*UpdatePipeOutput) SetCreationTime 

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

SetCreationTime sets the CreationTime field's value.

func (*UpdatePipeOutput) SetCurrentState 

func (s *UpdatePipeOutput) SetCurrentState(v string) *UpdatePipeOutput

SetCurrentState sets the CurrentState field's value.

func (*UpdatePipeOutput) SetDesiredState 

func (s *UpdatePipeOutput) SetDesiredState(v string) *UpdatePipeOutput

SetDesiredState sets the DesiredState field's value.

func (*UpdatePipeOutput) SetLastModifiedTime 

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

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*UpdatePipeOutput) SetName 

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

SetName sets the Name field's value.

func (UpdatePipeOutput) String 

func (s UpdatePipeOutput) 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 UpdatePipeSourceActiveMQBrokerParameters 

type UpdatePipeSourceActiveMQBrokerParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The credentials needed to access the resource.
	//
	// Credentials is a required field
	Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The parameters for using an Active MQ broker as a source.

func (UpdatePipeSourceActiveMQBrokerParameters) GoString 

func (s UpdatePipeSourceActiveMQBrokerParameters) 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 (*UpdatePipeSourceActiveMQBrokerParameters) SetBatchSize 

func (s *UpdatePipeSourceActiveMQBrokerParameters) SetBatchSize(v int64) *UpdatePipeSourceActiveMQBrokerParameters

SetBatchSize sets the BatchSize field's value.

func (*UpdatePipeSourceActiveMQBrokerParameters) SetCredentials 

func (s *UpdatePipeSourceActiveMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *UpdatePipeSourceActiveMQBrokerParameters

SetCredentials sets the Credentials field's value.

func (*UpdatePipeSourceActiveMQBrokerParameters) SetMaximumBatchingWindowInSeconds 

func (s *UpdatePipeSourceActiveMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceActiveMQBrokerParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (UpdatePipeSourceActiveMQBrokerParameters) String 

func (s UpdatePipeSourceActiveMQBrokerParameters) 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 (*UpdatePipeSourceActiveMQBrokerParameters) Validate 

func (s *UpdatePipeSourceActiveMQBrokerParameters) Validate() error

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

type UpdatePipeSourceDynamoDBStreamParameters 

type UpdatePipeSourceDynamoDBStreamParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// Define the target queue to send dead-letter queue events to.
	DeadLetterConfig *DeadLetterConfig `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records older than the specified age. The default
	// value is -1, which sets the maximum age to infinite. When the value is set
	// to infinite, EventBridge never discards old records.
	MaximumRecordAgeInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records after the specified number of retries. The
	// default value is -1, which sets the maximum number of retries to infinite.
	// When MaximumRetryAttempts is infinite, EventBridge retries failed records
	// until the record expires in the event source.
	MaximumRetryAttempts *int64 `type:"integer"`

	// (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT
	// halves each batch and retry each half until all the records are processed
	// or there is one failed message left in the batch.
	OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"`

	// (Streams only) The number of batches to process concurrently from each shard.
	// The default value is 1.
	ParallelizationFactor *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The parameters for using a DynamoDB stream as a source.

func (UpdatePipeSourceDynamoDBStreamParameters) GoString 

func (s UpdatePipeSourceDynamoDBStreamParameters) 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 (*UpdatePipeSourceDynamoDBStreamParameters) SetBatchSize 

func (s *UpdatePipeSourceDynamoDBStreamParameters) SetBatchSize(v int64) *UpdatePipeSourceDynamoDBStreamParameters

SetBatchSize sets the BatchSize field's value.

func (*UpdatePipeSourceDynamoDBStreamParameters) SetDeadLetterConfig 

func (s *UpdatePipeSourceDynamoDBStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *UpdatePipeSourceDynamoDBStreamParameters

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*UpdatePipeSourceDynamoDBStreamParameters) SetMaximumBatchingWindowInSeconds 

func (s *UpdatePipeSourceDynamoDBStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceDynamoDBStreamParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*UpdatePipeSourceDynamoDBStreamParameters) SetMaximumRecordAgeInSeconds 

func (s *UpdatePipeSourceDynamoDBStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *UpdatePipeSourceDynamoDBStreamParameters

SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value.

func (*UpdatePipeSourceDynamoDBStreamParameters) SetMaximumRetryAttempts 

func (s *UpdatePipeSourceDynamoDBStreamParameters) SetMaximumRetryAttempts(v int64) *UpdatePipeSourceDynamoDBStreamParameters

SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value.

func (*UpdatePipeSourceDynamoDBStreamParameters) SetOnPartialBatchItemFailure 

func (s *UpdatePipeSourceDynamoDBStreamParameters) SetOnPartialBatchItemFailure(v string) *UpdatePipeSourceDynamoDBStreamParameters

SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value.

func (*UpdatePipeSourceDynamoDBStreamParameters) SetParallelizationFactor 

func (s *UpdatePipeSourceDynamoDBStreamParameters) SetParallelizationFactor(v int64) *UpdatePipeSourceDynamoDBStreamParameters

SetParallelizationFactor sets the ParallelizationFactor field's value.

func (UpdatePipeSourceDynamoDBStreamParameters) String 

func (s UpdatePipeSourceDynamoDBStreamParameters) 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 (*UpdatePipeSourceDynamoDBStreamParameters) Validate 

func (s *UpdatePipeSourceDynamoDBStreamParameters) Validate() error

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

type UpdatePipeSourceKinesisStreamParameters 

type UpdatePipeSourceKinesisStreamParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// Define the target queue to send dead-letter queue events to.
	DeadLetterConfig *DeadLetterConfig `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records older than the specified age. The default
	// value is -1, which sets the maximum age to infinite. When the value is set
	// to infinite, EventBridge never discards old records.
	MaximumRecordAgeInSeconds *int64 `type:"integer"`

	// (Streams only) Discard records after the specified number of retries. The
	// default value is -1, which sets the maximum number of retries to infinite.
	// When MaximumRetryAttempts is infinite, EventBridge retries failed records
	// until the record expires in the event source.
	MaximumRetryAttempts *int64 `type:"integer"`

	// (Streams only) Define how to handle item process failures. AUTOMATIC_BISECT
	// halves each batch and retry each half until all the records are processed
	// or there is one failed message left in the batch.
	OnPartialBatchItemFailure *string `type:"string" enum:"OnPartialBatchItemFailureStreams"`

	// (Streams only) The number of batches to process concurrently from each shard.
	// The default value is 1.
	ParallelizationFactor *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The parameters for using a Kinesis stream as a source.

func (UpdatePipeSourceKinesisStreamParameters) GoString 

func (s UpdatePipeSourceKinesisStreamParameters) 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 (*UpdatePipeSourceKinesisStreamParameters) SetBatchSize 

func (s *UpdatePipeSourceKinesisStreamParameters) SetBatchSize(v int64) *UpdatePipeSourceKinesisStreamParameters

SetBatchSize sets the BatchSize field's value.

func (*UpdatePipeSourceKinesisStreamParameters) SetDeadLetterConfig 

func (s *UpdatePipeSourceKinesisStreamParameters) SetDeadLetterConfig(v *DeadLetterConfig) *UpdatePipeSourceKinesisStreamParameters

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*UpdatePipeSourceKinesisStreamParameters) SetMaximumBatchingWindowInSeconds 

func (s *UpdatePipeSourceKinesisStreamParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceKinesisStreamParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*UpdatePipeSourceKinesisStreamParameters) SetMaximumRecordAgeInSeconds 

func (s *UpdatePipeSourceKinesisStreamParameters) SetMaximumRecordAgeInSeconds(v int64) *UpdatePipeSourceKinesisStreamParameters

SetMaximumRecordAgeInSeconds sets the MaximumRecordAgeInSeconds field's value.

func (*UpdatePipeSourceKinesisStreamParameters) SetMaximumRetryAttempts 

func (s *UpdatePipeSourceKinesisStreamParameters) SetMaximumRetryAttempts(v int64) *UpdatePipeSourceKinesisStreamParameters

SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value.

func (*UpdatePipeSourceKinesisStreamParameters) SetOnPartialBatchItemFailure 

func (s *UpdatePipeSourceKinesisStreamParameters) SetOnPartialBatchItemFailure(v string) *UpdatePipeSourceKinesisStreamParameters

SetOnPartialBatchItemFailure sets the OnPartialBatchItemFailure field's value.

func (*UpdatePipeSourceKinesisStreamParameters) SetParallelizationFactor 

func (s *UpdatePipeSourceKinesisStreamParameters) SetParallelizationFactor(v int64) *UpdatePipeSourceKinesisStreamParameters

SetParallelizationFactor sets the ParallelizationFactor field's value.

func (UpdatePipeSourceKinesisStreamParameters) String 

func (s UpdatePipeSourceKinesisStreamParameters) 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 (*UpdatePipeSourceKinesisStreamParameters) Validate 

func (s *UpdatePipeSourceKinesisStreamParameters) Validate() error

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

type UpdatePipeSourceManagedStreamingKafkaParameters 

type UpdatePipeSourceManagedStreamingKafkaParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The credentials needed to access the resource.
	Credentials *MSKAccessCredentials `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The parameters for using an MSK stream as a source.

func (UpdatePipeSourceManagedStreamingKafkaParameters) GoString 

func (s UpdatePipeSourceManagedStreamingKafkaParameters) 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 (*UpdatePipeSourceManagedStreamingKafkaParameters) SetBatchSize 

func (s *UpdatePipeSourceManagedStreamingKafkaParameters) SetBatchSize(v int64) *UpdatePipeSourceManagedStreamingKafkaParameters

SetBatchSize sets the BatchSize field's value.

func (*UpdatePipeSourceManagedStreamingKafkaParameters) SetCredentials 

func (s *UpdatePipeSourceManagedStreamingKafkaParameters) SetCredentials(v *MSKAccessCredentials) *UpdatePipeSourceManagedStreamingKafkaParameters

SetCredentials sets the Credentials field's value.

func (*UpdatePipeSourceManagedStreamingKafkaParameters) SetMaximumBatchingWindowInSeconds 

func (s *UpdatePipeSourceManagedStreamingKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceManagedStreamingKafkaParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (UpdatePipeSourceManagedStreamingKafkaParameters) String 

func (s UpdatePipeSourceManagedStreamingKafkaParameters) 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 (*UpdatePipeSourceManagedStreamingKafkaParameters) Validate 

func (s *UpdatePipeSourceManagedStreamingKafkaParameters) Validate() error

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

type UpdatePipeSourceParameters 

type UpdatePipeSourceParameters struct {

	// The parameters for using an Active MQ broker as a source.
	ActiveMQBrokerParameters *UpdatePipeSourceActiveMQBrokerParameters `type:"structure"`

	// The parameters for using a DynamoDB stream as a source.
	DynamoDBStreamParameters *UpdatePipeSourceDynamoDBStreamParameters `type:"structure"`

	// The collection of event patterns used to filter events.
	//
	// To remove a filter, specify a FilterCriteria object with an empty array of
	// Filter objects.
	//
	// 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.
	FilterCriteria *FilterCriteria `type:"structure"`

	// The parameters for using a Kinesis stream as a source.
	KinesisStreamParameters *UpdatePipeSourceKinesisStreamParameters `type:"structure"`

	// The parameters for using an MSK stream as a source.
	ManagedStreamingKafkaParameters *UpdatePipeSourceManagedStreamingKafkaParameters `type:"structure"`

	// The parameters for using a Rabbit MQ broker as a source.
	RabbitMQBrokerParameters *UpdatePipeSourceRabbitMQBrokerParameters `type:"structure"`

	// The parameters for using a self-managed Apache Kafka stream as a source.
	SelfManagedKafkaParameters *UpdatePipeSourceSelfManagedKafkaParameters `type:"structure"`

	// The parameters for using a Amazon SQS stream as a source.
	SqsQueueParameters *UpdatePipeSourceSqsQueueParameters `type:"structure"`
	// contains filtered or unexported fields
}

The parameters required to set up a source for your pipe.

func (UpdatePipeSourceParameters) GoString 

func (s UpdatePipeSourceParameters) 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 (*UpdatePipeSourceParameters) SetActiveMQBrokerParameters 

func (s *UpdatePipeSourceParameters) SetActiveMQBrokerParameters(v *UpdatePipeSourceActiveMQBrokerParameters) *UpdatePipeSourceParameters

SetActiveMQBrokerParameters sets the ActiveMQBrokerParameters field's value.

func (*UpdatePipeSourceParameters) SetDynamoDBStreamParameters 

func (s *UpdatePipeSourceParameters) SetDynamoDBStreamParameters(v *UpdatePipeSourceDynamoDBStreamParameters) *UpdatePipeSourceParameters

SetDynamoDBStreamParameters sets the DynamoDBStreamParameters field's value.

func (*UpdatePipeSourceParameters) SetFilterCriteria 

func (s *UpdatePipeSourceParameters) SetFilterCriteria(v *FilterCriteria) *UpdatePipeSourceParameters

SetFilterCriteria sets the FilterCriteria field's value.

func (*UpdatePipeSourceParameters) SetKinesisStreamParameters 

func (s *UpdatePipeSourceParameters) SetKinesisStreamParameters(v *UpdatePipeSourceKinesisStreamParameters) *UpdatePipeSourceParameters

SetKinesisStreamParameters sets the KinesisStreamParameters field's value.

func (*UpdatePipeSourceParameters) SetManagedStreamingKafkaParameters 

func (s *UpdatePipeSourceParameters) SetManagedStreamingKafkaParameters(v *UpdatePipeSourceManagedStreamingKafkaParameters) *UpdatePipeSourceParameters

SetManagedStreamingKafkaParameters sets the ManagedStreamingKafkaParameters field's value.

func (*UpdatePipeSourceParameters) SetRabbitMQBrokerParameters 

func (s *UpdatePipeSourceParameters) SetRabbitMQBrokerParameters(v *UpdatePipeSourceRabbitMQBrokerParameters) *UpdatePipeSourceParameters

SetRabbitMQBrokerParameters sets the RabbitMQBrokerParameters field's value.

func (*UpdatePipeSourceParameters) SetSelfManagedKafkaParameters 

func (s *UpdatePipeSourceParameters) SetSelfManagedKafkaParameters(v *UpdatePipeSourceSelfManagedKafkaParameters) *UpdatePipeSourceParameters

SetSelfManagedKafkaParameters sets the SelfManagedKafkaParameters field's value.

func (*UpdatePipeSourceParameters) SetSqsQueueParameters 

func (s *UpdatePipeSourceParameters) SetSqsQueueParameters(v *UpdatePipeSourceSqsQueueParameters) *UpdatePipeSourceParameters

SetSqsQueueParameters sets the SqsQueueParameters field's value.

func (UpdatePipeSourceParameters) String 

func (s UpdatePipeSourceParameters) 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 (*UpdatePipeSourceParameters) Validate 

func (s *UpdatePipeSourceParameters) Validate() error

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

type UpdatePipeSourceRabbitMQBrokerParameters 

type UpdatePipeSourceRabbitMQBrokerParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The credentials needed to access the resource.
	//
	// Credentials is a required field
	Credentials *MQBrokerAccessCredentials `type:"structure" required:"true"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The parameters for using a Rabbit MQ broker as a source.

func (UpdatePipeSourceRabbitMQBrokerParameters) GoString 

func (s UpdatePipeSourceRabbitMQBrokerParameters) 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 (*UpdatePipeSourceRabbitMQBrokerParameters) SetBatchSize 

func (s *UpdatePipeSourceRabbitMQBrokerParameters) SetBatchSize(v int64) *UpdatePipeSourceRabbitMQBrokerParameters

SetBatchSize sets the BatchSize field's value.

func (*UpdatePipeSourceRabbitMQBrokerParameters) SetCredentials 

func (s *UpdatePipeSourceRabbitMQBrokerParameters) SetCredentials(v *MQBrokerAccessCredentials) *UpdatePipeSourceRabbitMQBrokerParameters

SetCredentials sets the Credentials field's value.

func (*UpdatePipeSourceRabbitMQBrokerParameters) SetMaximumBatchingWindowInSeconds 

func (s *UpdatePipeSourceRabbitMQBrokerParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceRabbitMQBrokerParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (UpdatePipeSourceRabbitMQBrokerParameters) String 

func (s UpdatePipeSourceRabbitMQBrokerParameters) 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 (*UpdatePipeSourceRabbitMQBrokerParameters) Validate 

func (s *UpdatePipeSourceRabbitMQBrokerParameters) Validate() error

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

type UpdatePipeSourceSelfManagedKafkaParameters 

type UpdatePipeSourceSelfManagedKafkaParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The credentials needed to access the resource.
	Credentials *SelfManagedKafkaAccessConfigurationCredentials `type:"structure"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`

	// The ARN of the Secrets Manager secret used for certification.
	ServerRootCaCertificate *string `min:"1" type:"string"`

	// This structure specifies the VPC subnets and security groups for the stream,
	// and whether a public IP address is to be used.
	Vpc *SelfManagedKafkaAccessConfigurationVpc `type:"structure"`
	// contains filtered or unexported fields
}

The parameters for using a self-managed Apache Kafka stream as a source.

func (UpdatePipeSourceSelfManagedKafkaParameters) GoString 

func (s UpdatePipeSourceSelfManagedKafkaParameters) 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 (*UpdatePipeSourceSelfManagedKafkaParameters) SetBatchSize 

func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetBatchSize(v int64) *UpdatePipeSourceSelfManagedKafkaParameters

SetBatchSize sets the BatchSize field's value.

func (*UpdatePipeSourceSelfManagedKafkaParameters) SetCredentials 

func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetCredentials(v *SelfManagedKafkaAccessConfigurationCredentials) *UpdatePipeSourceSelfManagedKafkaParameters

SetCredentials sets the Credentials field's value.

func (*UpdatePipeSourceSelfManagedKafkaParameters) SetMaximumBatchingWindowInSeconds 

func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceSelfManagedKafkaParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (*UpdatePipeSourceSelfManagedKafkaParameters) SetServerRootCaCertificate 

func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetServerRootCaCertificate(v string) *UpdatePipeSourceSelfManagedKafkaParameters

SetServerRootCaCertificate sets the ServerRootCaCertificate field's value.

func (*UpdatePipeSourceSelfManagedKafkaParameters) SetVpc 

func (s *UpdatePipeSourceSelfManagedKafkaParameters) SetVpc(v *SelfManagedKafkaAccessConfigurationVpc) *UpdatePipeSourceSelfManagedKafkaParameters

SetVpc sets the Vpc field's value.

func (UpdatePipeSourceSelfManagedKafkaParameters) String 

func (s UpdatePipeSourceSelfManagedKafkaParameters) 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 (*UpdatePipeSourceSelfManagedKafkaParameters) Validate 

func (s *UpdatePipeSourceSelfManagedKafkaParameters) Validate() error

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

type UpdatePipeSourceSqsQueueParameters 

type UpdatePipeSourceSqsQueueParameters struct {

	// The maximum number of records to include in each batch.
	BatchSize *int64 `min:"1" type:"integer"`

	// The maximum length of a time to wait for events.
	MaximumBatchingWindowInSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The parameters for using a Amazon SQS stream as a source.

func (UpdatePipeSourceSqsQueueParameters) GoString 

func (s UpdatePipeSourceSqsQueueParameters) 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 (*UpdatePipeSourceSqsQueueParameters) SetBatchSize 

func (s *UpdatePipeSourceSqsQueueParameters) SetBatchSize(v int64) *UpdatePipeSourceSqsQueueParameters

SetBatchSize sets the BatchSize field's value.

func (*UpdatePipeSourceSqsQueueParameters) SetMaximumBatchingWindowInSeconds 

func (s *UpdatePipeSourceSqsQueueParameters) SetMaximumBatchingWindowInSeconds(v int64) *UpdatePipeSourceSqsQueueParameters

SetMaximumBatchingWindowInSeconds sets the MaximumBatchingWindowInSeconds field's value.

func (UpdatePipeSourceSqsQueueParameters) String 

func (s UpdatePipeSourceSqsQueueParameters) 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 (*UpdatePipeSourceSqsQueueParameters) Validate 

func (s *UpdatePipeSourceSqsQueueParameters) Validate() error

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

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The list of fields for which validation failed and the corresponding failure
	// messages.
	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Indicates that an error has occurred while performing a validate operation.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) 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 (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) 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 ValidationExceptionField 

type ValidationExceptionField struct {

	// The message of the exception.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

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

Indicates that an error has occurred while performing a validate operation.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) 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 (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

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

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) 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 pipesiface provides an interface to enable mocking the Amazon EventBridge Pipes service client for testing your code.
 Package pipesiface provides an interface to enable mocking the Amazon EventBridge Pipes 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.