View a markdown version of this page

KnowledgeBaseRefreshScheduleSummary - AWS Quick

KnowledgeBaseRefreshScheduleSummary

A summary of a knowledge base refresh schedule, including its identifier, frequency, start time, and state. The DescribeKnowledgeBaseRefreshSchedule and ListKnowledgeBaseRefreshSchedules operations return this summary.

Contents

Note

In the following list, the required parameters are described first.

ScheduleFrequency

The frequency configuration for the refresh schedule. The frequency configuration specifies how often the schedule runs and, for weekly or monthly schedules, the day on which it runs.

Type: KnowledgeBaseRefreshFrequency object

Required: Yes

ScheduleId

The unique identifier for the refresh schedule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [0-9a-zA-Z_=-][0-9a-zA-Z_=.-]*

Required: Yes

StartTime

The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.

Type: Timestamp

Required: No

State

The current state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: