@aws-sdk/client-scheduler 3.295.0 → 3.297.0

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 {

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

@@ -1,10 +1,14 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { SchedulerServiceException as __BaseException } from "./SchedulerServiceException";
+/**
+ * @public
+ */
 export declare enum AssignPublicIp {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>Unexpected error encountered while processing the request.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -16,6 +20,9 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceInput {
     /**
      * <p>The ARN of the EventBridge Scheduler resource for which you want to view tags.</p>
@@ -23,6 +30,7 @@ export interface ListTagsForResourceInput {
     ResourceArn: string | undefined;
 }
 /**
+ * @public
  * <p>Tag to associate with a schedule group.</p>
  */
 export interface Tag {
@@ -35,6 +43,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceOutput {
     /**
      * <p>The list of tags associated with the specified resource.</p>
@@ -42,6 +53,7 @@ export interface ListTagsForResourceOutput {
     Tags?: Tag[];
 }
 /**
+ * @public
  * <p>The request references a resource which does not exist.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -54,6 +66,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied due to request throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -66,6 +79,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -78,6 +92,7 @@ export declare class ValidationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
 /**
+ * @public
  * <p>Updating or deleting the resource can cause an inconsistent state.</p>
  */
 export declare class ConflictException extends __BaseException {
@@ -89,11 +104,15 @@ export declare class ConflictException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum FlexibleTimeWindowMode {
     FLEXIBLE = "FLEXIBLE",
     OFF = "OFF"
 }
 /**
+ * @public
  * <p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>
  */
 export interface FlexibleTimeWindow {
@@ -106,11 +125,15 @@ export interface FlexibleTimeWindow {
      */
     MaximumWindowInMinutes?: number;
 }
+/**
+ * @public
+ */
 export declare enum ScheduleState {
     DISABLED = "DISABLED",
     ENABLED = "ENABLED"
 }
 /**
+ * @public
  * <p>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.</p>
  */
 export interface DeadLetterConfig {
@@ -120,6 +143,7 @@ export interface DeadLetterConfig {
     Arn?: string;
 }
 /**
+ * @public
  * <p>The details of a capacity provider strategy.</p>
  */
 export interface CapacityProviderStrategyItem {
@@ -138,12 +162,16 @@ export interface CapacityProviderStrategyItem {
      */
     base?: number;
 }
+/**
+ * @public
+ */
 export declare enum LaunchType {
     EC2 = "EC2",
     EXTERNAL = "EXTERNAL",
     FARGATE = "FARGATE"
 }
 /**
+ * @public
  * <p>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.</p>
  */
 export interface AwsVpcConfiguration {
@@ -162,6 +190,7 @@ export interface AwsVpcConfiguration {
     AssignPublicIp?: AssignPublicIp | string;
 }
 /**
+ * @public
  * <p>Specifies the network configuration for an ECS task.</p>
  */
 export interface NetworkConfiguration {
@@ -170,11 +199,15 @@ export interface NetworkConfiguration {
      */
     awsvpcConfiguration?: AwsVpcConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum PlacementConstraintType {
     DISTINCT_INSTANCE = "distinctInstance",
     MEMBER_OF = "memberOf"
 }
 /**
+ * @public
  * <p>An object representing a constraint on task placement.</p>
  */
 export interface PlacementConstraint {
@@ -188,12 +221,16 @@ export interface PlacementConstraint {
      */
     expression?: string;
 }
+/**
+ * @public
+ */
 export declare enum PlacementStrategyType {
     BINPACK = "binpack",
     RANDOM = "random",
     SPREAD = "spread"
 }
 /**
+ * @public
  * <p>The task placement strategy for a task or service.</p>
  */
 export interface PlacementStrategy {
@@ -210,10 +247,14 @@ export interface PlacementStrategy {
      */
     field?: string;
 }
+/**
+ * @public
+ */
 export declare enum PropagateTags {
     TASK_DEFINITION = "TASK_DEFINITION"
 }
 /**
+ * @public
  * <p>The templated target type for the Amazon ECS <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html">
  *                <code>RunTask</code>
  *             </a> API operation.</p>
@@ -288,6 +329,7 @@ export interface EcsParameters {
     Tags?: Record<string, string>[];
 }
 /**
+ * @public
  * <p>The templated target type for the EventBridge <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html">
  *                <code>PutEvents</code>
  *             </a> API operation.</p>
@@ -303,6 +345,7 @@ export interface EventBridgeParameters {
     Source: string | undefined;
 }
 /**
+ * @public
  * <p>The templated target type for the Amazon Kinesis <a href="kinesis/latest/APIReference/API_PutRecord.html">
  *                <code>PutRecord</code>
  *             </a> API operation.</p>
@@ -315,6 +358,7 @@ export interface KinesisParameters {
     PartitionKey: string | undefined;
 }
 /**
+ * @public
  * <p>A <code>RetryPolicy</code> 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.</p>
  */
 export interface RetryPolicy {
@@ -329,6 +373,7 @@ export interface RetryPolicy {
     MaximumRetryAttempts?: number;
 }
 /**
+ * @public
  * <p>The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.</p>
  */
 export interface SageMakerPipelineParameter {
@@ -342,6 +387,7 @@ export interface SageMakerPipelineParameter {
     Value: string | undefined;
 }
 /**
+ * @public
  * <p>The templated target type for the Amazon SageMaker <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html">
  *                <code>StartPipelineExecution</code>
  *             </a> API operation.</p>
@@ -353,6 +399,7 @@ export interface SageMakerPipelineParameters {
     PipelineParameterList?: SageMakerPipelineParameter[];
 }
 /**
+ * @public
  * <p>The templated target type for the Amazon SQS <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html">
  *                <code>SendMessage</code>
  *             </a> API operation.
@@ -368,6 +415,7 @@ export interface SqsParameters {
     MessageGroupId?: string;
 }
 /**
+ * @public
  * <p>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.</p>
  */
@@ -428,6 +476,9 @@ export interface Target {
      */
     SqsParameters?: SqsParameters;
 }
+/**
+ * @public
+ */
 export interface CreateScheduleInput {
     /**
      * <p>The name of the schedule that you are creating.</p>
@@ -518,6 +569,9 @@ export interface CreateScheduleInput {
      */
     ClientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateScheduleOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the schedule.</p>
@@ -525,6 +579,7 @@ export interface CreateScheduleOutput {
     ScheduleArn: string | undefined;
 }
 /**
+ * @public
  * <p>The request exceeds a service quota.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -536,6 +591,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteScheduleInput {
     /**
      * <p>The name of the schedule to delete.</p>
@@ -553,8 +611,14 @@ export interface DeleteScheduleInput {
      */
     ClientToken?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteScheduleOutput {
 }
+/**
+ * @public
+ */
 export interface GetScheduleInput {
     /**
      * <p>The name of the schedule to retrieve.</p>
@@ -565,6 +629,9 @@ export interface GetScheduleInput {
      */
     GroupName?: string;
 }
+/**
+ * @public
+ */
 export interface GetScheduleOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the schedule.</p>
@@ -660,6 +727,9 @@ export interface GetScheduleOutput {
      */
     FlexibleTimeWindow?: FlexibleTimeWindow;
 }
+/**
+ * @public
+ */
 export interface ListSchedulesInput {
     /**
      * <p>If specified, only lists the schedules whose associated schedule group matches the given filter.</p>
@@ -683,6 +753,7 @@ export interface ListSchedulesInput {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>The details of a target.</p>
  */
 export interface TargetSummary {
@@ -692,6 +763,7 @@ export interface TargetSummary {
     Arn: string | undefined;
 }
 /**
+ * @public
  * <p>The details of a schedule.</p>
  */
 export interface ScheduleSummary {
@@ -724,6 +796,9 @@ export interface ScheduleSummary {
      */
     Target?: TargetSummary;
 }
+/**
+ * @public
+ */
 export interface ListSchedulesOutput {
     /**
      * <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
@@ -734,6 +809,9 @@ export interface ListSchedulesOutput {
      */
     Schedules: ScheduleSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateScheduleInput {
     /**
      * <p>The name of the schedule that you are updating.</p>
@@ -825,12 +903,18 @@ export interface UpdateScheduleInput {
      */
     ClientToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateScheduleOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the schedule that you updated.</p>
      */
     ScheduleArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateScheduleGroupInput {
     /**
      * <p>The name of the schedule group that you are creating.</p>
@@ -848,12 +932,18 @@ export interface CreateScheduleGroupInput {
      */
     ClientToken?: string;
 }
+/**
+ * @public
+ */
 export interface CreateScheduleGroupOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the schedule group.</p>
      */
     ScheduleGroupArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteScheduleGroupInput {
     /**
      * <p>The name of the schedule group to delete.</p>
@@ -867,18 +957,30 @@ export interface DeleteScheduleGroupInput {
      */
     ClientToken?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteScheduleGroupOutput {
 }
+/**
+ * @public
+ */
 export interface GetScheduleGroupInput {
     /**
      * <p>The name of the schedule group to retrieve.</p>
      */
     Name: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ScheduleGroupState {
     ACTIVE = "ACTIVE",
     DELETING = "DELETING"
 }
+/**
+ * @public
+ */
 export interface GetScheduleGroupOutput {
     /**
      * <p>The Amazon Resource Name (ARN) of the schedule group.</p>
@@ -901,6 +1003,9 @@ export interface GetScheduleGroupOutput {
      */
     LastModificationDate?: Date;
 }
+/**
+ * @public
+ */
 export interface ListScheduleGroupsInput {
     /**
      * <p>The name prefix that you can use to return a filtered list of your schedule groups.</p>
@@ -916,6 +1021,7 @@ export interface ListScheduleGroupsInput {
     MaxResults?: number;
 }
 /**
+ * @public
  * <p>The details of a schedule group.</p>
  */
 export interface ScheduleGroupSummary {
@@ -940,6 +1046,9 @@ export interface ScheduleGroupSummary {
      */
     LastModificationDate?: Date;
 }
+/**
+ * @public
+ */
 export interface ListScheduleGroupsOutput {
     /**
      * <p>Indicates whether there are additional results to retrieve. If the value is null, there are no more results.</p>
@@ -950,6 +1059,9 @@ export interface ListScheduleGroupsOutput {
      */
     ScheduleGroups: ScheduleGroupSummary[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the schedule group that you are adding tags to.</p>
@@ -960,8 +1072,14 @@ export interface TagResourceInput {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceOutput {
 }
+/**
+ * @public
+ */
 export interface UntagResourceInput {
     /**
      * <p>The Amazon Resource Name (ARN) of the schedule group from which you are removing tags.</p>
@@ -972,6 +1090,9 @@ export interface UntagResourceInput {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceOutput {
 }
 /**

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { SchedulerClient } from "../SchedulerClient";
+/**
+ * @public
+ */
 export interface SchedulerPaginationConfiguration extends PaginationConfiguration {
     client: SchedulerClient;
 }

package/dist-types/pagination/ListScheduleGroupsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListScheduleGroupsCommandInput, ListScheduleGroupsCommandOutput } from "../commands/ListScheduleGroupsCommand";
 import { SchedulerPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListScheduleGroups(config: SchedulerPaginationConfiguration, input: ListScheduleGroupsCommandInput, ...additionalArguments: any): Paginator<ListScheduleGroupsCommandOutput>;

package/dist-types/pagination/ListSchedulesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListSchedulesCommandInput, ListSchedulesCommandOutput } from "../commands/ListSchedulesCommand";
 import { SchedulerPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListSchedules(config: SchedulerPaginationConfiguration, input: ListSchedulesCommandInput, ...additionalArguments: any): Paginator<ListSchedulesCommandOutput>;