scheduler

package
v0.0.0-...-ce01f02 Latest Latest
Warning

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

 Go to latest Published: Dec 27, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package scheduler provides the client and types for making API requests to Amazon EventBridge Scheduler.

Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler.

See https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30 for more information on this service.

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

Using the Client

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

Index

Constants

View Source 
const (
	// ActionAfterCompletionNone is a ActionAfterCompletion enum value
	ActionAfterCompletionNone = "NONE"

	// ActionAfterCompletionDelete is a ActionAfterCompletion enum value
	ActionAfterCompletionDelete = "DELETE"
)
View Source 
const (
	// AssignPublicIpEnabled is a AssignPublicIp enum value
	AssignPublicIpEnabled = "ENABLED"

	// AssignPublicIpDisabled is a AssignPublicIp enum value
	AssignPublicIpDisabled = "DISABLED"
)
View Source 
const (
	// FlexibleTimeWindowModeOff is a FlexibleTimeWindowMode enum value
	FlexibleTimeWindowModeOff = "OFF"

	// FlexibleTimeWindowModeFlexible is a FlexibleTimeWindowMode enum value
	FlexibleTimeWindowModeFlexible = "FLEXIBLE"
)
View Source 
const (
	// LaunchTypeEc2 is a LaunchType enum value
	LaunchTypeEc2 = "EC2"

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

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

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

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

	// PlacementStrategyTypeBinpack is a PlacementStrategyType enum value
	PlacementStrategyTypeBinpack = "binpack"
)
View Source 
const (
	// ScheduleGroupStateActive is a ScheduleGroupState enum value
	ScheduleGroupStateActive = "ACTIVE"

	// ScheduleGroupStateDeleting is a ScheduleGroupState enum value
	ScheduleGroupStateDeleting = "DELETING"
)
View Source 
const (
	// ScheduleStateEnabled is a ScheduleState enum value
	ScheduleStateEnabled = "ENABLED"

	// ScheduleStateDisabled is a ScheduleState enum value
	ScheduleStateDisabled = "DISABLED"
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Updating or deleting the resource can cause an inconsistent state.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Unexpected error encountered while processing the request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request references a resource which does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request exceeds a service quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by an AWS service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Scheduler" // Name of service.
	EndpointsID = "scheduler" // ID to lookup a service endpoint with.
	ServiceID   = "Scheduler" // ServiceID is a unique identifier of a specific service.
)

Service information constants

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

Variables

This section is empty.

Functions

func ActionAfterCompletion_Values 

func ActionAfterCompletion_Values() []string

ActionAfterCompletion_Values returns all elements of the ActionAfterCompletion enum

func AssignPublicIp_Values 

func AssignPublicIp_Values() []string

AssignPublicIp_Values returns all elements of the AssignPublicIp enum

func FlexibleTimeWindowMode_Values 

func FlexibleTimeWindowMode_Values() []string

FlexibleTimeWindowMode_Values returns all elements of the FlexibleTimeWindowMode enum

func LaunchType_Values 

func LaunchType_Values() []string

LaunchType_Values returns all elements of the LaunchType 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 ScheduleGroupState_Values 

func ScheduleGroupState_Values() []string

ScheduleGroupState_Values returns all elements of the ScheduleGroupState enum

func ScheduleState_Values 

func ScheduleState_Values() []string

ScheduleState_Values returns all elements of the ScheduleState 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 `min:"1" 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 `min:"1" 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 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 required field
	CapacityProvider *string `locationName:"capacityProvider" min:"1" type:"string" required:"true"`

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

The details of a capacity provider strategy.

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 ConflictException 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Updating or deleting the resource can cause an inconsistent state.

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 CreateScheduleGroupInput 

type CreateScheduleGroupInput struct {

	// Unique, case-sensitive identifier you provide to ensure the idempotency of
	// the request. If you do not specify a client token, EventBridge Scheduler
	// uses a randomly generated token for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The name of the schedule group that you are creating.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`

	// The list of tags to associate with the schedule group.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateScheduleGroupInput) GoString 

func (s CreateScheduleGroupInput) GoString() string

GoString returns the string representation.

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

func (*CreateScheduleGroupInput) SetClientToken 

func (s *CreateScheduleGroupInput) SetClientToken(v string) *CreateScheduleGroupInput

SetClientToken sets the ClientToken field's value.

func (*CreateScheduleGroupInput) SetName 

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

SetName sets the Name field's value.

func (*CreateScheduleGroupInput) SetTags 

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

SetTags sets the Tags field's value.

func (CreateScheduleGroupInput) String 

func (s CreateScheduleGroupInput) String() string

String returns the string representation.

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

func (*CreateScheduleGroupInput) Validate 

func (s *CreateScheduleGroupInput) Validate() error

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

type CreateScheduleGroupOutput 

type CreateScheduleGroupOutput struct {

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

func (CreateScheduleGroupOutput) GoString 

func (s CreateScheduleGroupOutput) GoString() string

GoString returns the string representation.

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

func (*CreateScheduleGroupOutput) SetScheduleGroupArn 

func (s *CreateScheduleGroupOutput) SetScheduleGroupArn(v string) *CreateScheduleGroupOutput

SetScheduleGroupArn sets the ScheduleGroupArn field's value.

func (CreateScheduleGroupOutput) String 

func (s CreateScheduleGroupOutput) String() string

String returns the string representation.

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

type CreateScheduleInput struct {

	// Specifies the action that EventBridge Scheduler applies to the schedule after
	// the schedule completes invoking the target.
	ActionAfterCompletion *string `type:"string" enum:"ActionAfterCompletion"`

	// Unique, case-sensitive identifier you provide to ensure the idempotency of
	// the request. If you do not specify a client token, EventBridge Scheduler
	// uses a randomly generated token for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The description you specify for the schedule.
	Description *string `type:"string"`

	// The date, in UTC, before which the schedule can invoke its target. Depending
	// on the schedule's recurrence expression, invocations might stop on, or before,
	// the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time
	// schedules.
	EndDate *time.Time `type:"timestamp"`

	// Allows you to configure a time window during which EventBridge Scheduler
	// invokes the schedule.
	//
	// FlexibleTimeWindow is a required field
	FlexibleTimeWindow *FlexibleTimeWindow `type:"structure" required:"true"`

	// The name of the schedule group to associate with this schedule. If you omit
	// this, the default schedule group is used.
	GroupName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge
	// Scheduler will use to encrypt and decrypt your data.
	KmsKeyArn *string `min:"1" type:"string"`

	// The name of the schedule that you are creating.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`

	// The expression that defines when the schedule runs. The following formats
	// are supported.
	//
	//    * at expression - at(yyyy-mm-ddThh:mm:ss)
	//
	//    * rate expression - rate(value unit)
	//
	//    * cron expression - cron(fields)
	//
	// You can use at expressions to create one-time schedules that invoke a target
	// once, at the time and in the time zone, that you specify. You can use rate
	// and cron expressions to create recurring schedules. Rate-based schedules
	// are useful when you want to invoke a target at regular intervals, such as
	// every 15 minutes or every five days. Cron-based schedules are useful when
	// you want to invoke a target periodically at a specific time, such as at 8:00
	// am (UTC+0) every 1st day of the month.
	//
	// A cron expression consists of six fields separated by white spaces: (minutes
	// hours day_of_month month day_of_week year).
	//
	// A rate expression consists of a value as a positive integer, and a unit with
	// the following options: minute | minutes | hour | hours | day | days
	//
	// For more information and examples, see Schedule types on EventBridge Scheduler
	// (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html)
	// in the EventBridge Scheduler User Guide.
	//
	// ScheduleExpression is a required field
	ScheduleExpression *string `min:"1" type:"string" required:"true"`

	// The timezone in which the scheduling expression is evaluated.
	ScheduleExpressionTimezone *string `min:"1" type:"string"`

	// The date, in UTC, after which the schedule can begin invoking its target.
	// Depending on the schedule's recurrence expression, invocations might occur
	// on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate
	// for one-time schedules.
	StartDate *time.Time `type:"timestamp"`

	// Specifies whether the schedule is enabled or disabled.
	State *string `type:"string" enum:"ScheduleState"`

	// The schedule's target.
	//
	// Target is a required field
	Target *Target `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateScheduleInput) GoString 

func (s CreateScheduleInput) GoString() string

GoString returns the string representation.

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

func (*CreateScheduleInput) SetActionAfterCompletion 

func (s *CreateScheduleInput) SetActionAfterCompletion(v string) *CreateScheduleInput

SetActionAfterCompletion sets the ActionAfterCompletion field's value.

func (*CreateScheduleInput) SetClientToken 

func (s *CreateScheduleInput) SetClientToken(v string) *CreateScheduleInput

SetClientToken sets the ClientToken field's value.

func (*CreateScheduleInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateScheduleInput) SetEndDate 

func (s *CreateScheduleInput) SetEndDate(v time.Time) *CreateScheduleInput

SetEndDate sets the EndDate field's value.

func (*CreateScheduleInput) SetFlexibleTimeWindow 

func (s *CreateScheduleInput) SetFlexibleTimeWindow(v *FlexibleTimeWindow) *CreateScheduleInput

SetFlexibleTimeWindow sets the FlexibleTimeWindow field's value.

func (*CreateScheduleInput) SetGroupName 

func (s *CreateScheduleInput) SetGroupName(v string) *CreateScheduleInput

SetGroupName sets the GroupName field's value.

func (*CreateScheduleInput) SetKmsKeyArn 

func (s *CreateScheduleInput) SetKmsKeyArn(v string) *CreateScheduleInput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*CreateScheduleInput) SetName 

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

SetName sets the Name field's value.

func (*CreateScheduleInput) SetScheduleExpression 

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

SetScheduleExpression sets the ScheduleExpression field's value.

func (*CreateScheduleInput) SetScheduleExpressionTimezone 

func (s *CreateScheduleInput) SetScheduleExpressionTimezone(v string) *CreateScheduleInput

SetScheduleExpressionTimezone sets the ScheduleExpressionTimezone field's value.

func (*CreateScheduleInput) SetStartDate 

func (s *CreateScheduleInput) SetStartDate(v time.Time) *CreateScheduleInput

SetStartDate sets the StartDate field's value.

func (*CreateScheduleInput) SetState 

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

SetState sets the State field's value.

func (*CreateScheduleInput) SetTarget 

func (s *CreateScheduleInput) SetTarget(v *Target) *CreateScheduleInput

SetTarget sets the Target field's value.

func (CreateScheduleInput) String 

func (s CreateScheduleInput) String() string

String returns the string representation.

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

func (*CreateScheduleInput) Validate 

func (s *CreateScheduleInput) Validate() error

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

type CreateScheduleOutput 

type CreateScheduleOutput struct {

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

func (CreateScheduleOutput) GoString 

func (s CreateScheduleOutput) GoString() string

GoString returns the string representation.

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

func (*CreateScheduleOutput) SetScheduleArn 

func (s *CreateScheduleOutput) SetScheduleArn(v string) *CreateScheduleOutput

SetScheduleArn sets the ScheduleArn field's value.

func (CreateScheduleOutput) String 

func (s CreateScheduleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 Amazon Resource Name (ARN) of the SQS queue specified as the destination
	// for the dead-letter queue.
	Arn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

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 DeleteScheduleGroupInput 

type DeleteScheduleGroupInput struct {

	// Unique, case-sensitive identifier you provide to ensure the idempotency of
	// the request. If you do not specify a client token, EventBridge Scheduler
	// uses a randomly generated token for the request to ensure idempotency.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

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

func (DeleteScheduleGroupInput) GoString 

func (s DeleteScheduleGroupInput) GoString() string

GoString returns the string representation.

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

func (*DeleteScheduleGroupInput) SetClientToken 

func (s *DeleteScheduleGroupInput) SetClientToken(v string) *DeleteScheduleGroupInput

SetClientToken sets the ClientToken field's value.

func (*DeleteScheduleGroupInput) SetName 

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

SetName sets the Name field's value.

func (DeleteScheduleGroupInput) String 

func (s DeleteScheduleGroupInput) String() string

String returns the string representation.

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

func (*DeleteScheduleGroupInput) Validate 

func (s *DeleteScheduleGroupInput) Validate() error

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

type DeleteScheduleGroupOutput 

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

func (DeleteScheduleGroupOutput) GoString 

func (s DeleteScheduleGroupOutput) GoString() string

GoString returns the string representation.

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

func (DeleteScheduleGroupOutput) String 

func (s DeleteScheduleGroupOutput) String() string

String returns the string representation.

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

type DeleteScheduleInput struct {

	// Unique, case-sensitive identifier you provide to ensure the idempotency of
	// the request. If you do not specify a client token, EventBridge Scheduler
	// uses a randomly generated token for the request to ensure idempotency.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The name of the schedule group associated with this schedule. If you omit
	// this, the default schedule group is used.
	GroupName *string `location:"querystring" locationName:"groupName" min:"1" type:"string"`

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

func (DeleteScheduleInput) GoString 

func (s DeleteScheduleInput) GoString() string

GoString returns the string representation.

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

func (*DeleteScheduleInput) SetClientToken 

func (s *DeleteScheduleInput) SetClientToken(v string) *DeleteScheduleInput

SetClientToken sets the ClientToken field's value.

func (*DeleteScheduleInput) SetGroupName 

func (s *DeleteScheduleInput) SetGroupName(v string) *DeleteScheduleInput

SetGroupName sets the GroupName field's value.

func (*DeleteScheduleInput) SetName 

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

SetName sets the Name field's value.

func (DeleteScheduleInput) String 

func (s DeleteScheduleInput) String() string

String returns the string representation.

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

func (*DeleteScheduleInput) Validate 

func (s *DeleteScheduleInput) Validate() error

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

type DeleteScheduleOutput 

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

func (DeleteScheduleOutput) GoString 

func (s DeleteScheduleOutput) GoString() string

GoString returns the string representation.

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

func (DeleteScheduleOutput) String 

func (s DeleteScheduleOutput) String() string

String returns the string representation.

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

type EcsParameters 

type EcsParameters struct {

	// The capacity provider strategy to use for the task.
	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 ECS Developer Guide.
	EnableECSManagedTags *bool `type:"boolean"`

	// Whether or not to enable the execute command functionality for the containers
	// in this task. If true, this enables execute command functionality on all
	// containers in the task.
	EnableExecuteCommand *bool `type:"boolean"`

	// Specifies an ECS task group for the task. The maximum length is 255 characters.
	Group *string `min:"1" 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 AWS Fargate
	// on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS_Fargate.html)
	// in the Amazon ECS Developer Guide.
	LaunchType *string `type:"string" enum:"LaunchType"`

	// This structure specifies the network configuration for an ECS task.
	NetworkConfiguration *NetworkConfiguration `type:"structure"`

	// An array of placement constraint objects to use for the task. You can specify
	// up to 10 constraints per task (including constraints in the task definition
	// and those specified at runtime).
	PlacementConstraints []*PlacementConstraint `type:"list"`

	// The task placement strategy for a task or service.
	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.
	PlatformVersion *string `min:"1" 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 Amazon ECS's TagResource (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html)
	// API action.
	PropagateTags *string `type:"string" enum:"PropagateTags"`

	// The reference ID to use for the task.
	ReferenceId *string `type:"string"`

	// The metadata that you apply to the task to help you categorize and organize
	// them. Each tag consists of a key and an optional value, both of which you
	// define. For more information, see RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)
	// in the Amazon ECS API Reference.
	Tags []map[string]*string `type:"list"`

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

	// The Amazon Resource Name (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 templated target type for the Amazon ECS RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.

func (EcsParameters) GoString 

func (s EcsParameters) GoString() string

GoString returns the string representation.

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

func (*EcsParameters) SetCapacityProviderStrategy 

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

SetCapacityProviderStrategy sets the CapacityProviderStrategy field's value.

func (*EcsParameters) SetEnableECSManagedTags 

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

SetEnableECSManagedTags sets the EnableECSManagedTags field's value.

func (*EcsParameters) SetEnableExecuteCommand 

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

SetEnableExecuteCommand sets the EnableExecuteCommand field's value.

func (*EcsParameters) SetGroup 

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

SetGroup sets the Group field's value.

func (*EcsParameters) SetLaunchType 

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

SetLaunchType sets the LaunchType field's value.

func (*EcsParameters) SetNetworkConfiguration 

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

SetNetworkConfiguration sets the NetworkConfiguration field's value.

func (*EcsParameters) SetPlacementConstraints 

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

SetPlacementConstraints sets the PlacementConstraints field's value.

func (*EcsParameters) SetPlacementStrategy 

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

SetPlacementStrategy sets the PlacementStrategy field's value.

func (*EcsParameters) SetPlatformVersion 

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

SetPlatformVersion sets the PlatformVersion field's value.

func (*EcsParameters) SetPropagateTags 

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

SetPropagateTags sets the PropagateTags field's value.

func (*EcsParameters) SetReferenceId 

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

SetReferenceId sets the ReferenceId field's value.

func (*EcsParameters) SetTags 

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

SetTags sets the Tags field's value.

func (*EcsParameters) SetTaskCount 

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

SetTaskCount sets the TaskCount field's value.

func (*EcsParameters) SetTaskDefinitionArn 

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

SetTaskDefinitionArn sets the TaskDefinitionArn field's value.

func (EcsParameters) String 

func (s EcsParameters) String() string

String returns the string representation.

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

func (*EcsParameters) Validate 

func (s *EcsParameters) Validate() error

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

type EventBridgeParameters 

type EventBridgeParameters 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 required field
	DetailType *string `min:"1" type:"string" required:"true"`

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

The templated target type for the EventBridge PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation.

func (EventBridgeParameters) GoString 

func (s EventBridgeParameters) GoString() string

GoString returns the string representation.

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

func (*EventBridgeParameters) SetDetailType 

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

SetDetailType sets the DetailType field's value.

func (*EventBridgeParameters) SetSource 

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

SetSource sets the Source field's value.

func (EventBridgeParameters) String 

func (s EventBridgeParameters) String() string

String returns the string representation.

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

func (*EventBridgeParameters) Validate 

func (s *EventBridgeParameters) Validate() error

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

type FlexibleTimeWindow 

type FlexibleTimeWindow struct {

	// The maximum time window during which a schedule can be invoked.
	MaximumWindowInMinutes *int64 `min:"1" type:"integer"`

	// Determines whether the schedule is invoked within a flexible time window.
	//
	// Mode is a required field
	Mode *string `type:"string" required:"true" enum:"FlexibleTimeWindowMode"`
	// contains filtered or unexported fields
}

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

func (FlexibleTimeWindow) GoString 

func (s FlexibleTimeWindow) GoString() string

GoString returns the string representation.

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

func (*FlexibleTimeWindow) SetMaximumWindowInMinutes 

func (s *FlexibleTimeWindow) SetMaximumWindowInMinutes(v int64) *FlexibleTimeWindow

SetMaximumWindowInMinutes sets the MaximumWindowInMinutes field's value.

func (*FlexibleTimeWindow) SetMode 

func (s *FlexibleTimeWindow) SetMode(v string) *FlexibleTimeWindow

SetMode sets the Mode field's value.

func (FlexibleTimeWindow) String 

func (s FlexibleTimeWindow) String() string

String returns the string representation.

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

func (*FlexibleTimeWindow) Validate 

func (s *FlexibleTimeWindow) Validate() error

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

type GetScheduleGroupInput 

type GetScheduleGroupInput struct {

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

func (GetScheduleGroupInput) GoString 

func (s GetScheduleGroupInput) GoString() string

GoString returns the string representation.

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

func (*GetScheduleGroupInput) SetName 

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

SetName sets the Name field's value.

func (GetScheduleGroupInput) String 

func (s GetScheduleGroupInput) String() string

String returns the string representation.

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

func (*GetScheduleGroupInput) Validate 

func (s *GetScheduleGroupInput) Validate() error

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

type GetScheduleGroupOutput 

type GetScheduleGroupOutput struct {

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

	// The time at which the schedule group was created.
	CreationDate *time.Time `type:"timestamp"`

	// The time at which the schedule group was last modified.
	LastModificationDate *time.Time `type:"timestamp"`

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

	// Specifies the state of the schedule group.
	State *string `type:"string" enum:"ScheduleGroupState"`
	// contains filtered or unexported fields
}

func (GetScheduleGroupOutput) GoString 

func (s GetScheduleGroupOutput) GoString() string

GoString returns the string representation.

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

func (*GetScheduleGroupOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*GetScheduleGroupOutput) SetCreationDate 

func (s *GetScheduleGroupOutput) SetCreationDate(v time.Time) *GetScheduleGroupOutput

SetCreationDate sets the CreationDate field's value.

func (*GetScheduleGroupOutput) SetLastModificationDate 

func (s *GetScheduleGroupOutput) SetLastModificationDate(v time.Time) *GetScheduleGroupOutput

SetLastModificationDate sets the LastModificationDate field's value.

func (*GetScheduleGroupOutput) SetName 

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

SetName sets the Name field's value.

func (*GetScheduleGroupOutput) SetState 

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

SetState sets the State field's value.

func (GetScheduleGroupOutput) String 

func (s GetScheduleGroupOutput) String() string

String returns the string representation.

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

type GetScheduleInput struct {

	// The name of the schedule group associated with this schedule. If you omit
	// this, EventBridge Scheduler assumes that the schedule is associated with
	// the default group.
	GroupName *string `location:"querystring" locationName:"groupName" min:"1" type:"string"`

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

func (GetScheduleInput) GoString 

func (s GetScheduleInput) GoString() string

GoString returns the string representation.

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

func (*GetScheduleInput) SetGroupName 

func (s *GetScheduleInput) SetGroupName(v string) *GetScheduleInput

SetGroupName sets the GroupName field's value.

func (*GetScheduleInput) SetName 

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

SetName sets the Name field's value.

func (GetScheduleInput) String 

func (s GetScheduleInput) String() string

String returns the string representation.

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

func (*GetScheduleInput) Validate 

func (s *GetScheduleInput) Validate() error

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

type GetScheduleOutput 

type GetScheduleOutput struct {

	// Indicates the action that EventBridge Scheduler applies to the schedule after
	// the schedule completes invoking the target.
	ActionAfterCompletion *string `type:"string" enum:"ActionAfterCompletion"`

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

	// The time at which the schedule was created.
	CreationDate *time.Time `type:"timestamp"`

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

	// The date, in UTC, before which the schedule can invoke its target. Depending
	// on the schedule's recurrence expression, invocations might stop on, or before,
	// the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time
	// schedules.
	EndDate *time.Time `type:"timestamp"`

	// Allows you to configure a time window during which EventBridge Scheduler
	// invokes the schedule.
	FlexibleTimeWindow *FlexibleTimeWindow `type:"structure"`

	// The name of the schedule group associated with this schedule.
	GroupName *string `min:"1" type:"string"`

	// The ARN for a customer managed KMS Key that is be used to encrypt and decrypt
	// your data.
	KmsKeyArn *string `min:"1" type:"string"`

	// The time at which the schedule was last modified.
	LastModificationDate *time.Time `type:"timestamp"`

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

	// The expression that defines when the schedule runs. The following formats
	// are supported.
	//
	//    * at expression - at(yyyy-mm-ddThh:mm:ss)
	//
	//    * rate expression - rate(value unit)
	//
	//    * cron expression - cron(fields)
	//
	// You can use at expressions to create one-time schedules that invoke a target
	// once, at the time and in the time zone, that you specify. You can use rate
	// and cron expressions to create recurring schedules. Rate-based schedules
	// are useful when you want to invoke a target at regular intervals, such as
	// every 15 minutes or every five days. Cron-based schedules are useful when
	// you want to invoke a target periodically at a specific time, such as at 8:00
	// am (UTC+0) every 1st day of the month.
	//
	// A cron expression consists of six fields separated by white spaces: (minutes
	// hours day_of_month month day_of_week year).
	//
	// A rate expression consists of a value as a positive integer, and a unit with
	// the following options: minute | minutes | hour | hours | day | days
	//
	// For more information and examples, see Schedule types on EventBridge Scheduler
	// (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html)
	// in the EventBridge Scheduler User Guide.
	ScheduleExpression *string `min:"1" type:"string"`

	// The timezone in which the scheduling expression is evaluated.
	ScheduleExpressionTimezone *string `min:"1" type:"string"`

	// The date, in UTC, after which the schedule can begin invoking its target.
	// Depending on the schedule's recurrence expression, invocations might occur
	// on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate
	// for one-time schedules.
	StartDate *time.Time `type:"timestamp"`

	// Specifies whether the schedule is enabled or disabled.
	State *string `type:"string" enum:"ScheduleState"`

	// The schedule target.
	Target *Target `type:"structure"`
	// contains filtered or unexported fields
}

func (GetScheduleOutput) GoString 

func (s GetScheduleOutput) GoString() string

GoString returns the string representation.

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

func (*GetScheduleOutput) SetActionAfterCompletion 

func (s *GetScheduleOutput) SetActionAfterCompletion(v string) *GetScheduleOutput

SetActionAfterCompletion sets the ActionAfterCompletion field's value.

func (*GetScheduleOutput) SetArn 

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

SetArn sets the Arn field's value.

func (*GetScheduleOutput) SetCreationDate 

func (s *GetScheduleOutput) SetCreationDate(v time.Time) *GetScheduleOutput

SetCreationDate sets the CreationDate field's value.

func (*GetScheduleOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*GetScheduleOutput) SetEndDate 

func (s *GetScheduleOutput) SetEndDate(v time.Time) *GetScheduleOutput

SetEndDate sets the EndDate field's value.

func (*GetScheduleOutput) SetFlexibleTimeWindow 

func (s *GetScheduleOutput) SetFlexibleTimeWindow(v *FlexibleTimeWindow) *GetScheduleOutput

SetFlexibleTimeWindow sets the FlexibleTimeWindow field's value.

func (*GetScheduleOutput) SetGroupName 

func (s *GetScheduleOutput) SetGroupName(v string) *GetScheduleOutput

SetGroupName sets the GroupName field's value.

func (*GetScheduleOutput) SetKmsKeyArn 

func (s *GetScheduleOutput) SetKmsKeyArn(v string) *GetScheduleOutput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*GetScheduleOutput) SetLastModificationDate 

func (s *GetScheduleOutput) SetLastModificationDate(v time.Time) *GetScheduleOutput

SetLastModificationDate sets the LastModificationDate field's value.

func (*GetScheduleOutput) SetName 

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

SetName sets the Name field's value.

func (*GetScheduleOutput) SetScheduleExpression 

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

SetScheduleExpression sets the ScheduleExpression field's value.

func (*GetScheduleOutput) SetScheduleExpressionTimezone 

func (s *GetScheduleOutput) SetScheduleExpressionTimezone(v string) *GetScheduleOutput

SetScheduleExpressionTimezone sets the ScheduleExpressionTimezone field's value.

func (*GetScheduleOutput) SetStartDate 

func (s *GetScheduleOutput) SetStartDate(v time.Time) *GetScheduleOutput

SetStartDate sets the StartDate field's value.

func (*GetScheduleOutput) SetState 

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

SetState sets the State field's value.

func (*GetScheduleOutput) SetTarget 

func (s *GetScheduleOutput) SetTarget(v *Target) *GetScheduleOutput

SetTarget sets the Target field's value.

func (GetScheduleOutput) String 

func (s GetScheduleOutput) String() string

String returns the string representation.

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

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unexpected error encountered while processing the request.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

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

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

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

type KinesisParameters 

type KinesisParameters struct {

	// Specifies the shard to which EventBridge Scheduler sends the event. For more
	// information, see Amazon Kinesis Data Streams terminology and concepts (https://docs.aws.amazon.com/streams/latest/dev/key-concepts.html)
	// in the Amazon Kinesis Streams Developer Guide.
	//
	// PartitionKey is a required field
	PartitionKey *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The templated target type for the Amazon Kinesis PutRecord (kinesis/latest/APIReference/API_PutRecord.html) API operation.

func (KinesisParameters) GoString 

func (s KinesisParameters) GoString() string

GoString returns the string representation.

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

func (*KinesisParameters) SetPartitionKey 

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

SetPartitionKey sets the PartitionKey field's value.

func (KinesisParameters) String 

func (s KinesisParameters) String() string

String returns the string representation.

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

func (*KinesisParameters) Validate 

func (s *KinesisParameters) Validate() error

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

type ListScheduleGroupsInput 

type ListScheduleGroupsInput struct {

	// If specified, limits the number of results returned by this operation. The
	// operation also returns a NextToken which you can use in a subsequent operation
	// to retrieve the next set of results.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The name prefix that you can use to return a filtered list of your schedule
	// groups.
	NamePrefix *string `location:"querystring" locationName:"NamePrefix" min:"1" type:"string"`

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

func (ListScheduleGroupsInput) GoString 

func (s ListScheduleGroupsInput) GoString() string

GoString returns the string representation.

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

func (*ListScheduleGroupsInput) SetMaxResults 

func (s *ListScheduleGroupsInput) SetMaxResults(v int64) *ListScheduleGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListScheduleGroupsInput) SetNamePrefix 

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

SetNamePrefix sets the NamePrefix field's value.

func (*ListScheduleGroupsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListScheduleGroupsInput) String 

func (s ListScheduleGroupsInput) String() string

String returns the string representation.

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

func (*ListScheduleGroupsInput) Validate 

func (s *ListScheduleGroupsInput) Validate() error

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

type ListScheduleGroupsOutput 

type ListScheduleGroupsOutput struct {

	// Indicates whether there are additional results to retrieve. If the value
	// is null, there are no more results.
	NextToken *string `min:"1" type:"string"`

	// The schedule groups that match the specified criteria.
	//
	// ScheduleGroups is a required field
	ScheduleGroups []*ScheduleGroupSummary `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListScheduleGroupsOutput) GoString 

func (s ListScheduleGroupsOutput) GoString() string

GoString returns the string representation.

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

func (*ListScheduleGroupsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListScheduleGroupsOutput) SetScheduleGroups 

func (s *ListScheduleGroupsOutput) SetScheduleGroups(v []*ScheduleGroupSummary) *ListScheduleGroupsOutput

SetScheduleGroups sets the ScheduleGroups field's value.

func (ListScheduleGroupsOutput) String 

func (s ListScheduleGroupsOutput) String() string

String returns the string representation.

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

type ListSchedulesInput struct {

	// If specified, only lists the schedules whose associated schedule group matches
	// the given filter.
	GroupName *string `location:"querystring" locationName:"ScheduleGroup" min:"1" type:"string"`

	// If specified, limits the number of results returned by this operation. The
	// operation also returns a NextToken which you can use in a subsequent operation
	// to retrieve the next set of results.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// Schedule name prefix to return the filtered list of resources.
	NamePrefix *string `location:"querystring" locationName:"NamePrefix" min:"1" type:"string"`

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

	// If specified, only lists the schedules whose current state matches the given
	// filter.
	State *string `location:"querystring" locationName:"State" type:"string" enum:"ScheduleState"`
	// contains filtered or unexported fields
}

func (ListSchedulesInput) GoString 

func (s ListSchedulesInput) GoString() string

GoString returns the string representation.

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

func (*ListSchedulesInput) SetGroupName 

func (s *ListSchedulesInput) SetGroupName(v string) *ListSchedulesInput

SetGroupName sets the GroupName field's value.

func (*ListSchedulesInput) SetMaxResults 

func (s *ListSchedulesInput) SetMaxResults(v int64) *ListSchedulesInput

SetMaxResults sets the MaxResults field's value.

func (*ListSchedulesInput) SetNamePrefix 

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

SetNamePrefix sets the NamePrefix field's value.

func (*ListSchedulesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSchedulesInput) SetState 

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

SetState sets the State field's value.

func (ListSchedulesInput) String 

func (s ListSchedulesInput) String() string

String returns the string representation.

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

func (*ListSchedulesInput) Validate 

func (s *ListSchedulesInput) Validate() error

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

type ListSchedulesOutput 

type ListSchedulesOutput struct {

	// Indicates whether there are additional results to retrieve. If the value
	// is null, there are no more results.
	NextToken *string `min:"1" type:"string"`

	// The schedules that match the specified criteria.
	//
	// Schedules is a required field
	Schedules []*ScheduleSummary `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListSchedulesOutput) GoString 

func (s ListSchedulesOutput) GoString() string

GoString returns the string representation.

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

func (*ListSchedulesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListSchedulesOutput) SetSchedules 

func (s *ListSchedulesOutput) SetSchedules(v []*ScheduleSummary) *ListSchedulesOutput

SetSchedules sets the Schedules field's value.

func (ListSchedulesOutput) String 

func (s ListSchedulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 EventBridge Scheduler resource 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 tags associated with the specified resource.
	Tags []*Tag `type:"list"`
	// 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 []*Tag) *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 NetworkConfiguration 

type NetworkConfiguration struct {

	// Specifies the Amazon 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
}

Specifies the network configuration for an 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 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. For more
	// information, see Cluster query language (https://docs.aws.amazon.com/latest/developerguide/cluster-query-language.html)
	// in the Amazon ECS Developer Guide.
	Expression *string `locationName:"expression" type:"string"`

	// The type of constraint. Use distinctInstance to ensure that each task in
	// a particular group is running on a different container instance. Use memberOf
	// to restrict the selection to a group of valid candidates.
	Type *string `locationName:"type" type:"string" enum:"PlacementConstraintType"`
	// contains filtered or unexported fields
}

An object representing a constraint on task placement.

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 instanceId, which has the same
	// effect), or any platform or custom attribute that is applied to a container
	// instance, such as attribute:ecs.availability-zone. For the binpack placement
	// strategy, valid values are cpu and memory. For the random placement strategy,
	// this field is not used.
	Field *string `locationName:"field" type:"string"`

	// The type of placement strategy. The random placement strategy randomly places
	// tasks on available candidates. The spread placement strategy spreads placement
	// across available candidates evenly based on the field parameter. The binpack
	// strategy places tasks on available candidates that have the least available
	// amount of the resource that is specified with the field parameter. For example,
	// if you binpack on memory, a task is placed on the instance with the least
	// amount of remaining memory (but still enough to run the task).
	Type *string `locationName:"type" type:"string" enum:"PlacementStrategyType"`
	// contains filtered or unexported fields
}

The task placement strategy for a task or service.

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 ResourceNotFoundException 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request references a resource which does not exist.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

type RetryPolicy 

type RetryPolicy struct {

	// The maximum amount of time, in seconds, to continue to make retry attempts.
	MaximumEventAgeInSeconds *int64 `min:"60" type:"integer"`

	// The maximum number of retry attempts to make before the request fails. Retry
	// attempts with exponential backoff continue until either the maximum number
	// of attempts is made or until the duration of the MaximumEventAgeInSeconds
	// is reached.
	MaximumRetryAttempts *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

func (RetryPolicy) GoString 

func (s RetryPolicy) GoString() string

GoString returns the string representation.

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

func (*RetryPolicy) SetMaximumEventAgeInSeconds 

func (s *RetryPolicy) SetMaximumEventAgeInSeconds(v int64) *RetryPolicy

SetMaximumEventAgeInSeconds sets the MaximumEventAgeInSeconds field's value.

func (*RetryPolicy) SetMaximumRetryAttempts 

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

SetMaximumRetryAttempts sets the MaximumRetryAttempts field's value.

func (RetryPolicy) String 

func (s RetryPolicy) String() string

String returns the string representation.

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

func (*RetryPolicy) Validate 

func (s *RetryPolicy) 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 required field
	Name *string `min:"1" type:"string" required:"true"`

	// Value of parameter to start execution of a SageMaker Model Building Pipeline.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The name and value pair of a parameter to use 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 SageMakerPipelineParameters 

type SageMakerPipelineParameters struct {

	// List of parameter names and values to use when executing the SageMaker Model
	// Building Pipeline.
	PipelineParameterList []*SageMakerPipelineParameter `type:"list"`
	// contains filtered or unexported fields
}

The templated target type for the Amazon SageMaker StartPipelineExecution (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html) API operation.

func (SageMakerPipelineParameters) GoString 

func (s SageMakerPipelineParameters) GoString() string

GoString returns the string representation.

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

func (*SageMakerPipelineParameters) SetPipelineParameterList 

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

SetPipelineParameterList sets the PipelineParameterList field's value.

func (SageMakerPipelineParameters) String 

func (s SageMakerPipelineParameters) String() string

String returns the string representation.

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

func (*SageMakerPipelineParameters) Validate 

func (s *SageMakerPipelineParameters) Validate() error

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

type ScheduleGroupSummary 

type ScheduleGroupSummary struct {

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

	// The time at which the schedule group was created.
	CreationDate *time.Time `type:"timestamp"`

	// The time at which the schedule group was last modified.
	LastModificationDate *time.Time `type:"timestamp"`

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

	// Specifies the state of the schedule group.
	State *string `type:"string" enum:"ScheduleGroupState"`
	// contains filtered or unexported fields
}

The details of a schedule group.

func (ScheduleGroupSummary) GoString 

func (s ScheduleGroupSummary) GoString() string

GoString returns the string representation.

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

func (*ScheduleGroupSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*ScheduleGroupSummary) SetCreationDate 

func (s *ScheduleGroupSummary) SetCreationDate(v time.Time) *ScheduleGroupSummary

SetCreationDate sets the CreationDate field's value.

func (*ScheduleGroupSummary) SetLastModificationDate 

func (s *ScheduleGroupSummary) SetLastModificationDate(v time.Time) *ScheduleGroupSummary

SetLastModificationDate sets the LastModificationDate field's value.

func (*ScheduleGroupSummary) SetName 

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

SetName sets the Name field's value.

func (*ScheduleGroupSummary) SetState 

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

SetState sets the State field's value.

func (ScheduleGroupSummary) String 

func (s ScheduleGroupSummary) String() string

String returns the string representation.

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

type ScheduleSummary struct {

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

	// The time at which the schedule was created.
	CreationDate *time.Time `type:"timestamp"`

	// The name of the schedule group associated with this schedule.
	GroupName *string `min:"1" type:"string"`

	// The time at which the schedule was last modified.
	LastModificationDate *time.Time `type:"timestamp"`

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

	// Specifies whether the schedule is enabled or disabled.
	State *string `type:"string" enum:"ScheduleState"`

	// The schedule's target details.
	Target *TargetSummary `type:"structure"`
	// contains filtered or unexported fields
}

The details of a schedule.

func (ScheduleSummary) GoString 

func (s ScheduleSummary) GoString() string

GoString returns the string representation.

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

func (*ScheduleSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*ScheduleSummary) SetCreationDate 

func (s *ScheduleSummary) SetCreationDate(v time.Time) *ScheduleSummary

SetCreationDate sets the CreationDate field's value.

func (*ScheduleSummary) SetGroupName 

func (s *ScheduleSummary) SetGroupName(v string) *ScheduleSummary

SetGroupName sets the GroupName field's value.

func (*ScheduleSummary) SetLastModificationDate 

func (s *ScheduleSummary) SetLastModificationDate(v time.Time) *ScheduleSummary

SetLastModificationDate sets the LastModificationDate field's value.

func (*ScheduleSummary) SetName 

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

SetName sets the Name field's value.

func (*ScheduleSummary) SetState 

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

SetState sets the State field's value.

func (*ScheduleSummary) SetTarget 

func (s *ScheduleSummary) SetTarget(v *TargetSummary) *ScheduleSummary

SetTarget sets the Target field's value.

func (ScheduleSummary) String 

func (s ScheduleSummary) String() string

String returns the string representation.

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

type Scheduler struct {
	*client.Client
}

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

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

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

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

func (*Scheduler) CreateSchedule 

func (c *Scheduler) CreateSchedule(input *CreateScheduleInput) (*CreateScheduleOutput, error)

CreateSchedule API operation for Amazon EventBridge Scheduler.

Creates the specified schedule.

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 Scheduler's API operation CreateSchedule for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeds a service quota.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ConflictException Updating or deleting the resource can cause an inconsistent state.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/CreateSchedule

func (*Scheduler) CreateScheduleGroup 

func (c *Scheduler) CreateScheduleGroup(input *CreateScheduleGroupInput) (*CreateScheduleGroupOutput, error)

CreateScheduleGroup API operation for Amazon EventBridge Scheduler.

Creates the specified schedule group.

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 Scheduler's API operation CreateScheduleGroup for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request exceeds a service quota.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ConflictException Updating or deleting the resource can cause an inconsistent state.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/CreateScheduleGroup

func (*Scheduler) CreateScheduleGroupRequest 

func (c *Scheduler) CreateScheduleGroupRequest(input *CreateScheduleGroupInput) (req *request.Request, output *CreateScheduleGroupOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/CreateScheduleGroup

func (*Scheduler) CreateScheduleGroupWithContext 

func (c *Scheduler) CreateScheduleGroupWithContext(ctx aws.Context, input *CreateScheduleGroupInput, opts ...request.Option) (*CreateScheduleGroupOutput, error)

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

See CreateScheduleGroup 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 (*Scheduler) CreateScheduleRequest 

func (c *Scheduler) CreateScheduleRequest(input *CreateScheduleInput) (req *request.Request, output *CreateScheduleOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/CreateSchedule

func (*Scheduler) CreateScheduleWithContext 

func (c *Scheduler) CreateScheduleWithContext(ctx aws.Context, input *CreateScheduleInput, opts ...request.Option) (*CreateScheduleOutput, error)

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

See CreateSchedule 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 (*Scheduler) DeleteSchedule 

func (c *Scheduler) DeleteSchedule(input *DeleteScheduleInput) (*DeleteScheduleOutput, error)

DeleteSchedule API operation for Amazon EventBridge Scheduler.

Deletes the specified schedule.

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 Scheduler's API operation DeleteSchedule for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ConflictException Updating or deleting the resource can cause an inconsistent state.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/DeleteSchedule

func (*Scheduler) DeleteScheduleGroup 

func (c *Scheduler) DeleteScheduleGroup(input *DeleteScheduleGroupInput) (*DeleteScheduleGroupOutput, error)

DeleteScheduleGroup API operation for Amazon EventBridge Scheduler.

Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a DELETING state until all of its associated schedules are deleted. Schedules associated with the group that are set to run while the schedule group is in the process of being deleted might continue to invoke their targets until the schedule group and its associated schedules are deleted.

This operation is eventually consistent.

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 Scheduler's API operation DeleteScheduleGroup for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ConflictException Updating or deleting the resource can cause an inconsistent state.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/DeleteScheduleGroup

func (*Scheduler) DeleteScheduleGroupRequest 

func (c *Scheduler) DeleteScheduleGroupRequest(input *DeleteScheduleGroupInput) (req *request.Request, output *DeleteScheduleGroupOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/DeleteScheduleGroup

func (*Scheduler) DeleteScheduleGroupWithContext 

func (c *Scheduler) DeleteScheduleGroupWithContext(ctx aws.Context, input *DeleteScheduleGroupInput, opts ...request.Option) (*DeleteScheduleGroupOutput, error)

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

See DeleteScheduleGroup 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 (*Scheduler) DeleteScheduleRequest 

func (c *Scheduler) DeleteScheduleRequest(input *DeleteScheduleInput) (req *request.Request, output *DeleteScheduleOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/DeleteSchedule

func (*Scheduler) DeleteScheduleWithContext 

func (c *Scheduler) DeleteScheduleWithContext(ctx aws.Context, input *DeleteScheduleInput, opts ...request.Option) (*DeleteScheduleOutput, error)

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

See DeleteSchedule 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 (*Scheduler) GetSchedule 

func (c *Scheduler) GetSchedule(input *GetScheduleInput) (*GetScheduleOutput, error)

GetSchedule API operation for Amazon EventBridge Scheduler.

Retrieves the specified schedule.

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 Scheduler's API operation GetSchedule for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/GetSchedule

func (*Scheduler) GetScheduleGroup 

func (c *Scheduler) GetScheduleGroup(input *GetScheduleGroupInput) (*GetScheduleGroupOutput, error)

GetScheduleGroup API operation for Amazon EventBridge Scheduler.

Retrieves the specified schedule group.

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 Scheduler's API operation GetScheduleGroup for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/GetScheduleGroup

func (*Scheduler) GetScheduleGroupRequest 

func (c *Scheduler) GetScheduleGroupRequest(input *GetScheduleGroupInput) (req *request.Request, output *GetScheduleGroupOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/GetScheduleGroup

func (*Scheduler) GetScheduleGroupWithContext 

func (c *Scheduler) GetScheduleGroupWithContext(ctx aws.Context, input *GetScheduleGroupInput, opts ...request.Option) (*GetScheduleGroupOutput, error)

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

See GetScheduleGroup 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 (*Scheduler) GetScheduleRequest 

func (c *Scheduler) GetScheduleRequest(input *GetScheduleInput) (req *request.Request, output *GetScheduleOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/GetSchedule

func (*Scheduler) GetScheduleWithContext 

func (c *Scheduler) GetScheduleWithContext(ctx aws.Context, input *GetScheduleInput, opts ...request.Option) (*GetScheduleOutput, error)

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

See GetSchedule 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 (*Scheduler) ListScheduleGroups 

func (c *Scheduler) ListScheduleGroups(input *ListScheduleGroupsInput) (*ListScheduleGroupsOutput, error)

ListScheduleGroups API operation for Amazon EventBridge Scheduler.

Returns a paginated list of your schedule groups.

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 Scheduler's API operation ListScheduleGroups for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/ListScheduleGroups

func (*Scheduler) ListScheduleGroupsPages 

func (c *Scheduler) ListScheduleGroupsPages(input *ListScheduleGroupsInput, fn func(*ListScheduleGroupsOutput, bool) bool) error

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

See ListScheduleGroups 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 ListScheduleGroups operation.
pageNum := 0
err := client.ListScheduleGroupsPages(params,
    func(page *scheduler.ListScheduleGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Scheduler) ListScheduleGroupsPagesWithContext 

func (c *Scheduler) ListScheduleGroupsPagesWithContext(ctx aws.Context, input *ListScheduleGroupsInput, fn func(*ListScheduleGroupsOutput, bool) bool, opts ...request.Option) error

ListScheduleGroupsPagesWithContext same as ListScheduleGroupsPages 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 (*Scheduler) ListScheduleGroupsRequest 

func (c *Scheduler) ListScheduleGroupsRequest(input *ListScheduleGroupsInput) (req *request.Request, output *ListScheduleGroupsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/ListScheduleGroups

func (*Scheduler) ListScheduleGroupsWithContext 

func (c *Scheduler) ListScheduleGroupsWithContext(ctx aws.Context, input *ListScheduleGroupsInput, opts ...request.Option) (*ListScheduleGroupsOutput, error)

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

See ListScheduleGroups 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 (*Scheduler) ListSchedules 

func (c *Scheduler) ListSchedules(input *ListSchedulesInput) (*ListSchedulesOutput, error)

ListSchedules API operation for Amazon EventBridge Scheduler.

Returns a paginated list of your EventBridge Scheduler schedules.

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 Scheduler's API operation ListSchedules for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/ListSchedules

func (*Scheduler) ListSchedulesPages 

func (c *Scheduler) ListSchedulesPages(input *ListSchedulesInput, fn func(*ListSchedulesOutput, bool) bool) error

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

See ListSchedules 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 ListSchedules operation.
pageNum := 0
err := client.ListSchedulesPages(params,
    func(page *scheduler.ListSchedulesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Scheduler) ListSchedulesPagesWithContext 

func (c *Scheduler) ListSchedulesPagesWithContext(ctx aws.Context, input *ListSchedulesInput, fn func(*ListSchedulesOutput, bool) bool, opts ...request.Option) error

ListSchedulesPagesWithContext same as ListSchedulesPages 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 (*Scheduler) ListSchedulesRequest 

func (c *Scheduler) ListSchedulesRequest(input *ListSchedulesInput) (req *request.Request, output *ListSchedulesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/ListSchedules

func (*Scheduler) ListSchedulesWithContext 

func (c *Scheduler) ListSchedulesWithContext(ctx aws.Context, input *ListSchedulesInput, opts ...request.Option) (*ListSchedulesOutput, error)

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

See ListSchedules 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 (*Scheduler) ListTagsForResource 

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

ListTagsForResource API operation for Amazon EventBridge Scheduler.

Lists the tags associated with the Scheduler resource.

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

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

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/ListTagsForResource

func (*Scheduler) ListTagsForResourceRequest 

func (c *Scheduler) 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/scheduler-2021-06-30/ListTagsForResource

func (*Scheduler) ListTagsForResourceWithContext 

func (c *Scheduler) 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 (*Scheduler) TagResource 

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

TagResource API operation for Amazon EventBridge Scheduler.

Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.

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

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ConflictException Updating or deleting the resource can cause an inconsistent state.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/TagResource

func (*Scheduler) TagResourceRequest 

func (c *Scheduler) 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/scheduler-2021-06-30/TagResource

func (*Scheduler) TagResourceWithContext 

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

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

UntagResource API operation for Amazon EventBridge Scheduler.

Removes one or more tags from the specified EventBridge Scheduler schedule group.

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

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ConflictException Updating or deleting the resource can cause an inconsistent state.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/UntagResource

func (*Scheduler) UntagResourceRequest 

func (c *Scheduler) 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/scheduler-2021-06-30/UntagResource

func (*Scheduler) UntagResourceWithContext 

func (c *Scheduler) 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 (*Scheduler) UpdateSchedule 

func (c *Scheduler) UpdateSchedule(input *UpdateScheduleInput) (*UpdateScheduleOutput, error)

UpdateSchedule API operation for Amazon EventBridge Scheduler.

Updates the specified schedule. When you call UpdateSchedule, EventBridge Scheduler uses all values, including empty values, specified in the request and overrides the existing schedule. This is by design. This means that if you do not set an optional field in your request, that field will be set to its system-default value after the update.

Before calling this operation, we recommend that you call the GetSchedule API operation and make a note of all optional parameters for your UpdateSchedule call.

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 Scheduler's API operation UpdateSchedule for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • InternalServerException Unexpected error encountered while processing the request.

  • ConflictException Updating or deleting the resource can cause an inconsistent state.

  • ResourceNotFoundException The request references a resource which does not exist.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/UpdateSchedule

func (*Scheduler) UpdateScheduleRequest 

func (c *Scheduler) UpdateScheduleRequest(input *UpdateScheduleInput) (req *request.Request, output *UpdateScheduleOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/scheduler-2021-06-30/UpdateSchedule

func (*Scheduler) UpdateScheduleWithContext 

func (c *Scheduler) UpdateScheduleWithContext(ctx aws.Context, input *UpdateScheduleInput, opts ...request.Option) (*UpdateScheduleOutput, error)

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

See UpdateSchedule 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 ServiceQuotaExceededException 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request exceeds a service quota.

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 SqsParameters 

type SqsParameters struct {

	// The FIFO message group ID to use as the target.
	MessageGroupId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The templated target type for the Amazon SQS SendMessage (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html) API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html) in the Amazon SQS Developer Guide.

func (SqsParameters) GoString 

func (s SqsParameters) GoString() string

GoString returns the string representation.

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

func (*SqsParameters) SetMessageGroupId 

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

SetMessageGroupId sets the MessageGroupId field's value.

func (SqsParameters) String 

func (s SqsParameters) String() string

String returns the string representation.

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

func (*SqsParameters) Validate 

func (s *SqsParameters) Validate() error

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

type Tag 

type Tag struct {

	// The key for the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

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

Tag to associate with a schedule group.

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 Amazon Resource Name (ARN) of the schedule group that you are adding
	// tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"ResourceArn" min:"1" type:"string" required:"true"`

	// The list of tags to associate with the schedule group.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" 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 []*Tag) *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 Target 

type Target struct {

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

	// An object that contains information about an Amazon SQS queue that EventBridge
	// Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge
	// Scheduler delivers failed events that could not be successfully delivered
	// to a target to the queue.
	DeadLetterConfig *DeadLetterConfig `type:"structure"`

	// The templated target type for the Amazon ECS RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)
	// API operation.
	EcsParameters *EcsParameters `type:"structure"`

	// The templated target type for the EventBridge PutEvents (https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html)
	// API operation.
	EventBridgeParameters *EventBridgeParameters `type:"structure"`

	// The text, or well-formed JSON, passed to the target. If you are configuring
	// a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the
	// input must be a well-formed JSON. For all other target types, a JSON is not
	// required. If you do not specify anything for this field, EventBridge Scheduler
	// delivers a default notification to the target.
	Input *string `min:"1" type:"string"`

	// The templated target type for the Amazon Kinesis PutRecord (kinesis/latest/APIReference/API_PutRecord.html)
	// API operation.
	KinesisParameters *KinesisParameters `type:"structure"`

	// A RetryPolicy object that includes information about the retry policy settings,
	// including the maximum age of an event, and the maximum number of times EventBridge
	// Scheduler will try to deliver the event to a target.
	RetryPolicy *RetryPolicy `type:"structure"`

	// The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler
	// will use for this target when the schedule is invoked.
	//
	// RoleArn is a required field
	RoleArn *string `min:"1" type:"string" required:"true"`

	// The templated target type for the Amazon SageMaker StartPipelineExecution
	// (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html)
	// API operation.
	SageMakerPipelineParameters *SageMakerPipelineParameters `type:"structure"`

	// The templated target type for the Amazon SQS SendMessage (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html)
	// API operation. Contains the message group ID to use when the target is a
	// FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue
	// must have content-based deduplication enabled. For more information, see
	// Using the Amazon SQS message deduplication ID (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html)
	// in the Amazon SQS Developer Guide.
	SqsParameters *SqsParameters `type:"structure"`
	// contains filtered or unexported fields
}

The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

func (Target) GoString 

func (s Target) GoString() string

GoString returns the string representation.

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

func (*Target) SetArn 

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

SetArn sets the Arn field's value.

func (*Target) SetDeadLetterConfig 

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

SetDeadLetterConfig sets the DeadLetterConfig field's value.

func (*Target) SetEcsParameters 

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

SetEcsParameters sets the EcsParameters field's value.

func (*Target) SetEventBridgeParameters 

func (s *Target) SetEventBridgeParameters(v *EventBridgeParameters) *Target

SetEventBridgeParameters sets the EventBridgeParameters field's value.

func (*Target) SetInput 

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

SetInput sets the Input field's value.

func (*Target) SetKinesisParameters 

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

SetKinesisParameters sets the KinesisParameters field's value.

func (*Target) SetRetryPolicy 

func (s *Target) SetRetryPolicy(v *RetryPolicy) *Target

SetRetryPolicy sets the RetryPolicy field's value.

func (*Target) SetRoleArn 

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

SetRoleArn sets the RoleArn field's value.

func (*Target) SetSageMakerPipelineParameters 

func (s *Target) SetSageMakerPipelineParameters(v *SageMakerPipelineParameters) *Target

SetSageMakerPipelineParameters sets the SageMakerPipelineParameters field's value.

func (*Target) SetSqsParameters 

func (s *Target) SetSqsParameters(v *SqsParameters) *Target

SetSqsParameters sets the SqsParameters field's value.

func (Target) String 

func (s Target) String() string

String returns the string representation.

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

func (*Target) Validate 

func (s *Target) Validate() error

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

type TargetSummary 

type TargetSummary struct {

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

The details of a target.

func (TargetSummary) GoString 

func (s TargetSummary) GoString() string

GoString returns the string representation.

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

func (*TargetSummary) SetArn 

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

SetArn sets the Arn field's value.

func (TargetSummary) String 

func (s TargetSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

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 Amazon Resource Name (ARN) of the schedule group from which you are removing
	// tags.
	//
	// 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 resource.
	//
	// 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 UpdateScheduleInput 

type UpdateScheduleInput struct {

	// Specifies the action that EventBridge Scheduler applies to the schedule after
	// the schedule completes invoking the target.
	ActionAfterCompletion *string `type:"string" enum:"ActionAfterCompletion"`

	// Unique, case-sensitive identifier you provide to ensure the idempotency of
	// the request. If you do not specify a client token, EventBridge Scheduler
	// uses a randomly generated token for the request to ensure idempotency.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The description you specify for the schedule.
	Description *string `type:"string"`

	// The date, in UTC, before which the schedule can invoke its target. Depending
	// on the schedule's recurrence expression, invocations might stop on, or before,
	// the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time
	// schedules.
	EndDate *time.Time `type:"timestamp"`

	// Allows you to configure a time window during which EventBridge Scheduler
	// invokes the schedule.
	//
	// FlexibleTimeWindow is a required field
	FlexibleTimeWindow *FlexibleTimeWindow `type:"structure" required:"true"`

	// The name of the schedule group with which the schedule is associated. You
	// must provide this value in order for EventBridge Scheduler to find the schedule
	// you want to update. If you omit this value, EventBridge Scheduler assumes
	// the group is associated to the default group.
	GroupName *string `min:"1" type:"string"`

	// The ARN for the customer managed KMS key that that you want EventBridge Scheduler
	// to use to encrypt and decrypt your data.
	KmsKeyArn *string `min:"1" type:"string"`

	// The name of the schedule that you are updating.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"Name" min:"1" type:"string" required:"true"`

	// The expression that defines when the schedule runs. The following formats
	// are supported.
	//
	//    * at expression - at(yyyy-mm-ddThh:mm:ss)
	//
	//    * rate expression - rate(value unit)
	//
	//    * cron expression - cron(fields)
	//
	// You can use at expressions to create one-time schedules that invoke a target
	// once, at the time and in the time zone, that you specify. You can use rate
	// and cron expressions to create recurring schedules. Rate-based schedules
	// are useful when you want to invoke a target at regular intervals, such as
	// every 15 minutes or every five days. Cron-based schedules are useful when
	// you want to invoke a target periodically at a specific time, such as at 8:00
	// am (UTC+0) every 1st day of the month.
	//
	// A cron expression consists of six fields separated by white spaces: (minutes
	// hours day_of_month month day_of_week year).
	//
	// A rate expression consists of a value as a positive integer, and a unit with
	// the following options: minute | minutes | hour | hours | day | days
	//
	// For more information and examples, see Schedule types on EventBridge Scheduler
	// (https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html)
	// in the EventBridge Scheduler User Guide.
	//
	// ScheduleExpression is a required field
	ScheduleExpression *string `min:"1" type:"string" required:"true"`

	// The timezone in which the scheduling expression is evaluated.
	ScheduleExpressionTimezone *string `min:"1" type:"string"`

	// The date, in UTC, after which the schedule can begin invoking its target.
	// Depending on the schedule's recurrence expression, invocations might occur
	// on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate
	// for one-time schedules.
	StartDate *time.Time `type:"timestamp"`

	// Specifies whether the schedule is enabled or disabled.
	State *string `type:"string" enum:"ScheduleState"`

	// The schedule target. You can use this operation to change the target that
	// your schedule invokes.
	//
	// Target is a required field
	Target *Target `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateScheduleInput) GoString 

func (s UpdateScheduleInput) GoString() string

GoString returns the string representation.

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

func (*UpdateScheduleInput) SetActionAfterCompletion 

func (s *UpdateScheduleInput) SetActionAfterCompletion(v string) *UpdateScheduleInput

SetActionAfterCompletion sets the ActionAfterCompletion field's value.

func (*UpdateScheduleInput) SetClientToken 

func (s *UpdateScheduleInput) SetClientToken(v string) *UpdateScheduleInput

SetClientToken sets the ClientToken field's value.

func (*UpdateScheduleInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateScheduleInput) SetEndDate 

func (s *UpdateScheduleInput) SetEndDate(v time.Time) *UpdateScheduleInput

SetEndDate sets the EndDate field's value.

func (*UpdateScheduleInput) SetFlexibleTimeWindow 

func (s *UpdateScheduleInput) SetFlexibleTimeWindow(v *FlexibleTimeWindow) *UpdateScheduleInput

SetFlexibleTimeWindow sets the FlexibleTimeWindow field's value.

func (*UpdateScheduleInput) SetGroupName 

func (s *UpdateScheduleInput) SetGroupName(v string) *UpdateScheduleInput

SetGroupName sets the GroupName field's value.

func (*UpdateScheduleInput) SetKmsKeyArn 

func (s *UpdateScheduleInput) SetKmsKeyArn(v string) *UpdateScheduleInput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*UpdateScheduleInput) SetName 

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

SetName sets the Name field's value.

func (*UpdateScheduleInput) SetScheduleExpression 

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

SetScheduleExpression sets the ScheduleExpression field's value.

func (*UpdateScheduleInput) SetScheduleExpressionTimezone 

func (s *UpdateScheduleInput) SetScheduleExpressionTimezone(v string) *UpdateScheduleInput

SetScheduleExpressionTimezone sets the ScheduleExpressionTimezone field's value.

func (*UpdateScheduleInput) SetStartDate 

func (s *UpdateScheduleInput) SetStartDate(v time.Time) *UpdateScheduleInput

SetStartDate sets the StartDate field's value.

func (*UpdateScheduleInput) SetState 

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

SetState sets the State field's value.

func (*UpdateScheduleInput) SetTarget 

func (s *UpdateScheduleInput) SetTarget(v *Target) *UpdateScheduleInput

SetTarget sets the Target field's value.

func (UpdateScheduleInput) String 

func (s UpdateScheduleInput) String() string

String returns the string representation.

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

func (*UpdateScheduleInput) Validate 

func (s *UpdateScheduleInput) Validate() error

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

type UpdateScheduleOutput 

type UpdateScheduleOutput struct {

	// The Amazon Resource Name (ARN) of the schedule that you updated.
	//
	// ScheduleArn is a required field
	ScheduleArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateScheduleOutput) GoString 

func (s UpdateScheduleOutput) GoString() string

GoString returns the string representation.

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

func (*UpdateScheduleOutput) SetScheduleArn 

func (s *UpdateScheduleOutput) SetScheduleArn(v string) *UpdateScheduleOutput

SetScheduleArn sets the ScheduleArn field's value.

func (UpdateScheduleOutput) String 

func (s UpdateScheduleOutput) String() string

String returns the string representation.

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

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an AWS service.

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

Source Files

View all Source files

Directories

Path Synopsis
Package scheduleriface provides an interface to enable mocking the Amazon EventBridge Scheduler service client for testing your code.
 Package scheduleriface provides an interface to enable mocking the Amazon EventBridge Scheduler 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.