@aws-sdk/client-scheduler 3.296.0 → 3.298.0

package/dist-types/commands/ListScheduleGroupsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListScheduleGroupsInput, ListScheduleGroupsOutput } from "../models/models_0";
 import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
 /**
+ * @public
+ *
  * The input for {@link ListScheduleGroupsCommand}.
  */
 export interface ListScheduleGroupsCommandInput extends ListScheduleGroupsInput {
 }
 /**
+ * @public
+ *
  * The output of {@link ListScheduleGroupsCommand}.
  */
 export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a paginated list of your schedule groups.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutpu
  * const response = await client.send(command);
  * ```
  *
+ * @param ListScheduleGroupsCommandInput - {@link ListScheduleGroupsCommandInput}
+ * @returns {@link ListScheduleGroupsCommandOutput}
  * @see {@link ListScheduleGroupsCommandInput} for command's `input` shape.
  * @see {@link ListScheduleGroupsCommandOutput} for command's `response` shape.
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListScheduleGroupsCommandOutput extends ListScheduleGroupsOutpu
 export declare class ListScheduleGroupsCommand extends $Command<ListScheduleGroupsCommandInput, ListScheduleGroupsCommandOutput, SchedulerClientResolvedConfig> {
     readonly input: ListScheduleGroupsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListScheduleGroupsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListScheduleGroupsCommandInput, ListScheduleGroupsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListSchedulesCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListSchedulesInput, ListSchedulesOutput } from "../models/models_0";
 import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
 /**
+ * @public
+ *
  * The input for {@link ListSchedulesCommand}.
  */
 export interface ListSchedulesCommandInput extends ListSchedulesInput {
 }
 /**
+ * @public
+ *
  * The output of {@link ListSchedulesCommand}.
  */
 export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a paginated list of your EventBridge Scheduler schedules.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param ListSchedulesCommandInput - {@link ListSchedulesCommandInput}
+ * @returns {@link ListSchedulesCommandOutput}
  * @see {@link ListSchedulesCommandInput} for command's `input` shape.
  * @see {@link ListSchedulesCommandOutput} for command's `response` shape.
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListSchedulesCommandOutput extends ListSchedulesOutput, __Metad
 export declare class ListSchedulesCommand extends $Command<ListSchedulesCommandInput, ListSchedulesCommandOutput, SchedulerClientResolvedConfig> {
     readonly input: ListSchedulesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListSchedulesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSchedulesCommandInput, ListSchedulesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
 import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Lists the tags associated with the Scheduler resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SchedulerClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagResourceInput, TagResourceOutput } from "../models/models_0";
 import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SchedulerClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
 import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes one or more tags from the specified EventBridge Scheduler schedule group.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SchedulerClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateScheduleCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateScheduleInput, UpdateScheduleOutput } from "../models/models_0";
 import { SchedulerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SchedulerClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateScheduleCommand}.
  */
 export interface UpdateScheduleCommandInput extends UpdateScheduleInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateScheduleCommand}.
  */
 export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>
  *          Updates the specified schedule. When you call <code>UpdateSchedule</code>, 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
@@ -33,6 +38,8 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateScheduleCommandInput - {@link UpdateScheduleCommandInput}
+ * @returns {@link UpdateScheduleCommandOutput}
  * @see {@link UpdateScheduleCommandInput} for command's `input` shape.
  * @see {@link UpdateScheduleCommandOutput} for command's `response` shape.
  * @see {@link SchedulerClientResolvedConfig | config} for SchedulerClient's `config` shape.
@@ -57,11 +64,20 @@ export interface UpdateScheduleCommandOutput extends UpdateScheduleOutput, __Met
 export declare class UpdateScheduleCommand extends $Command<UpdateScheduleCommandInput, UpdateScheduleCommandOutput, SchedulerClientResolvedConfig> {
     readonly input: UpdateScheduleCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateScheduleCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SchedulerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateScheduleCommandInput, UpdateScheduleCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SchedulerServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Scheduler service.
  */
 export declare class SchedulerServiceException extends __ServiceException {