@aws-sdk/client-data-pipeline 3.296.0 → 3.298.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { DataPipelineServiceException as __BaseException } from "./DataPipelineServiceException";
 /**
+ * @public
  * <p>A value or list of parameter values. </p>
  */
 export interface ParameterValue {
@@ -14,6 +15,7 @@ export interface ParameterValue {
     stringValue: string | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for ActivatePipeline.</p>
  */
 export interface ActivatePipelineInput {
@@ -31,11 +33,13 @@ export interface ActivatePipelineInput {
     startTimestamp?: Date;
 }
 /**
+ * @public
  * <p>Contains the output of ActivatePipeline.</p>
  */
 export interface ActivatePipelineOutput {
 }
 /**
+ * @public
  * <p>An internal service error occurred.</p>
  */
 export declare class InternalServiceError extends __BaseException {
@@ -47,6 +51,7 @@ export declare class InternalServiceError extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServiceError, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>
  */
 export declare class InvalidRequestException extends __BaseException {
@@ -58,6 +63,7 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified pipeline has been deleted.</p>
  */
 export declare class PipelineDeletedException extends __BaseException {
@@ -69,6 +75,7 @@ export declare class PipelineDeletedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<PipelineDeletedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>
  */
 export declare class PipelineNotFoundException extends __BaseException {
@@ -80,6 +87,7 @@ export declare class PipelineNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<PipelineNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline.
  *             For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>
  */
@@ -96,6 +104,7 @@ export interface Tag {
     value: string | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for AddTags.</p>
  */
 export interface AddTagsInput {
@@ -109,11 +118,13 @@ export interface AddTagsInput {
     tags: Tag[] | undefined;
 }
 /**
+ * @public
  * <p>Contains the output of AddTags.</p>
  */
 export interface AddTagsOutput {
 }
 /**
+ * @public
  * <p>Contains the parameters for CreatePipeline.</p>
  */
 export interface CreatePipelineInput {
@@ -145,6 +156,7 @@ export interface CreatePipelineInput {
     tags?: Tag[];
 }
 /**
+ * @public
  * <p>Contains the output of CreatePipeline.</p>
  */
 export interface CreatePipelineOutput {
@@ -154,6 +166,7 @@ export interface CreatePipelineOutput {
     pipelineId: string | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for DeactivatePipeline.</p>
  */
 export interface DeactivatePipelineInput {
@@ -170,11 +183,13 @@ export interface DeactivatePipelineInput {
     cancelActive?: boolean;
 }
 /**
+ * @public
  * <p>Contains the output of DeactivatePipeline.</p>
  */
 export interface DeactivatePipelineOutput {
 }
 /**
+ * @public
  * <p>Contains the parameters for DeletePipeline.</p>
  */
 export interface DeletePipelineInput {
@@ -184,6 +199,7 @@ export interface DeletePipelineInput {
     pipelineId: string | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for DescribeObjects.</p>
  */
 export interface DescribeObjectsInput {
@@ -207,6 +223,7 @@ export interface DescribeObjectsInput {
     marker?: string;
 }
 /**
+ * @public
  * <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>
  */
 export interface Field {
@@ -224,6 +241,7 @@ export interface Field {
     refValue?: string;
 }
 /**
+ * @public
  * <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>
  */
 export interface PipelineObject {
@@ -241,6 +259,7 @@ export interface PipelineObject {
     fields: Field[] | undefined;
 }
 /**
+ * @public
  * <p>Contains the output of DescribeObjects.</p>
  */
 export interface DescribeObjectsOutput {
@@ -259,6 +278,7 @@ export interface DescribeObjectsOutput {
     hasMoreResults?: boolean;
 }
 /**
+ * @public
  * <p>Contains the parameters for DescribePipelines.</p>
  */
 export interface DescribePipelinesInput {
@@ -269,6 +289,7 @@ export interface DescribePipelinesInput {
     pipelineIds: string[] | undefined;
 }
 /**
+ * @public
  * <p>Contains pipeline metadata.</p>
  */
 export interface PipelineDescription {
@@ -295,6 +316,7 @@ export interface PipelineDescription {
     tags?: Tag[];
 }
 /**
+ * @public
  * <p>Contains the output of DescribePipelines.</p>
  */
 export interface DescribePipelinesOutput {
@@ -304,6 +326,7 @@ export interface DescribePipelinesOutput {
     pipelineDescriptionList: PipelineDescription[] | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for EvaluateExpression.</p>
  */
 export interface EvaluateExpressionInput {
@@ -321,6 +344,7 @@ export interface EvaluateExpressionInput {
     expression: string | undefined;
 }
 /**
+ * @public
  * <p>Contains the output of EvaluateExpression.</p>
  */
 export interface EvaluateExpressionOutput {
@@ -330,6 +354,7 @@ export interface EvaluateExpressionOutput {
     evaluatedExpression: string | undefined;
 }
 /**
+ * @public
  * <p>The specified task was not found. </p>
  */
 export declare class TaskNotFoundException extends __BaseException {
@@ -341,6 +366,7 @@ export declare class TaskNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<TaskNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>Contains the parameters for GetPipelineDefinition.</p>
  */
 export interface GetPipelineDefinitionInput {
@@ -356,6 +382,7 @@ export interface GetPipelineDefinitionInput {
     version?: string;
 }
 /**
+ * @public
  * <p>The attributes allowed or specified with a parameter object.</p>
  */
 export interface ParameterAttribute {
@@ -369,6 +396,7 @@ export interface ParameterAttribute {
     stringValue: string | undefined;
 }
 /**
+ * @public
  * <p>Contains information about a parameter object.</p>
  */
 export interface ParameterObject {
@@ -382,6 +410,7 @@ export interface ParameterObject {
     attributes: ParameterAttribute[] | undefined;
 }
 /**
+ * @public
  * <p>Contains the output of GetPipelineDefinition.</p>
  */
 export interface GetPipelineDefinitionOutput {
@@ -399,6 +428,7 @@ export interface GetPipelineDefinitionOutput {
     parameterValues?: ParameterValue[];
 }
 /**
+ * @public
  * <p>Contains the parameters for ListPipelines.</p>
  */
 export interface ListPipelinesInput {
@@ -410,6 +440,7 @@ export interface ListPipelinesInput {
     marker?: string;
 }
 /**
+ * @public
  * <p>Contains the name and identifier of a pipeline.</p>
  */
 export interface PipelineIdName {
@@ -423,6 +454,7 @@ export interface PipelineIdName {
     name?: string;
 }
 /**
+ * @public
  * <p>Contains the output of ListPipelines.</p>
  */
 export interface ListPipelinesOutput {
@@ -442,6 +474,7 @@ export interface ListPipelinesOutput {
     hasMoreResults?: boolean;
 }
 /**
+ * @public
  * <p><p>Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance.
  *             For more information, see <a href="http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i>
  *             Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p></p>
@@ -457,6 +490,7 @@ export interface InstanceIdentity {
     signature?: string;
 }
 /**
+ * @public
  * <p>Contains the parameters for PollForTask.</p>
  */
 export interface PollForTaskInput {
@@ -476,6 +510,7 @@ export interface PollForTaskInput {
     instanceIdentity?: InstanceIdentity;
 }
 /**
+ * @public
  * <p>Contains information about a pipeline task that is assigned to a task runner.</p>
  */
 export interface TaskObject {
@@ -497,6 +532,7 @@ export interface TaskObject {
     objects?: Record<string, PipelineObject>;
 }
 /**
+ * @public
  * <p>Contains the output of PollForTask.</p>
  */
 export interface PollForTaskOutput {
@@ -508,6 +544,7 @@ export interface PollForTaskOutput {
     taskObject?: TaskObject;
 }
 /**
+ * @public
  * <p>Contains the parameters for PutPipelineDefinition.</p>
  */
 export interface PutPipelineDefinitionInput {
@@ -529,6 +566,7 @@ export interface PutPipelineDefinitionInput {
     parameterValues?: ParameterValue[];
 }
 /**
+ * @public
  * <p>Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>
  */
 export interface ValidationError {
@@ -542,6 +580,7 @@ export interface ValidationError {
     errors?: string[];
 }
 /**
+ * @public
  * <p>Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>
  */
 export interface ValidationWarning {
@@ -555,6 +594,7 @@ export interface ValidationWarning {
     warnings?: string[];
 }
 /**
+ * @public
  * <p>Contains the output of PutPipelineDefinition.</p>
  */
 export interface PutPipelineDefinitionOutput {
@@ -572,6 +612,9 @@ export interface PutPipelineDefinitionOutput {
      */
     errored: boolean | undefined;
 }
+/**
+ * @public
+ */
 export declare enum OperatorType {
     Between = "BETWEEN",
     Equal = "EQ",
@@ -580,6 +623,7 @@ export declare enum OperatorType {
     ReferenceEqual = "REF_EQ"
 }
 /**
+ * @public
  * <p>Contains a logical operation for comparing the value of a field with a specified value.</p>
  */
 export interface Operator {
@@ -621,6 +665,7 @@ export interface Operator {
     values?: string[];
 }
 /**
+ * @public
  * <p>A comparision that is used to determine whether a query should return this object.</p>
  */
 export interface Selector {
@@ -634,6 +679,7 @@ export interface Selector {
     operator?: Operator;
 }
 /**
+ * @public
  * <p>Defines the query to run against an object.</p>
  */
 export interface Query {
@@ -643,6 +689,7 @@ export interface Query {
     selectors?: Selector[];
 }
 /**
+ * @public
  * <p>Contains the parameters for QueryObjects.</p>
  */
 export interface QueryObjectsInput {
@@ -673,6 +720,7 @@ export interface QueryObjectsInput {
     limit?: number;
 }
 /**
+ * @public
  * <p>Contains the output of QueryObjects.</p>
  */
 export interface QueryObjectsOutput {
@@ -691,6 +739,7 @@ export interface QueryObjectsOutput {
     hasMoreResults?: boolean;
 }
 /**
+ * @public
  * <p>Contains the parameters for RemoveTags.</p>
  */
 export interface RemoveTagsInput {
@@ -704,11 +753,13 @@ export interface RemoveTagsInput {
     tagKeys: string[] | undefined;
 }
 /**
+ * @public
  * <p>Contains the output of RemoveTags.</p>
  */
 export interface RemoveTagsOutput {
 }
 /**
+ * @public
  * <p>Contains the parameters for ReportTaskProgress.</p>
  */
 export interface ReportTaskProgressInput {
@@ -722,6 +773,7 @@ export interface ReportTaskProgressInput {
     fields?: Field[];
 }
 /**
+ * @public
  * <p>Contains the output of ReportTaskProgress.</p>
  */
 export interface ReportTaskProgressOutput {
@@ -731,6 +783,7 @@ export interface ReportTaskProgressOutput {
     canceled: boolean | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for ReportTaskRunnerHeartbeat.</p>
  */
 export interface ReportTaskRunnerHeartbeatInput {
@@ -752,6 +805,7 @@ export interface ReportTaskRunnerHeartbeatInput {
     hostname?: string;
 }
 /**
+ * @public
  * <p>Contains the output of ReportTaskRunnerHeartbeat.</p>
  */
 export interface ReportTaskRunnerHeartbeatOutput {
@@ -761,6 +815,7 @@ export interface ReportTaskRunnerHeartbeatOutput {
     terminate: boolean | undefined;
 }
 /**
+ * @public
  * <p>Contains the parameters for SetStatus.</p>
  */
 export interface SetStatusInput {
@@ -778,12 +833,16 @@ export interface SetStatusInput {
      */
     status: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum TaskStatus {
     FAILED = "FAILED",
     FALSE = "FALSE",
     FINISHED = "FINISHED"
 }
 /**
+ * @public
  * <p>Contains the parameters for SetTaskStatus.</p>
  */
 export interface SetTaskStatusInput {
@@ -812,11 +871,13 @@ export interface SetTaskStatusInput {
     errorStackTrace?: string;
 }
 /**
+ * @public
  * <p>Contains the output of SetTaskStatus.</p>
  */
 export interface SetTaskStatusOutput {
 }
 /**
+ * @public
  * <p>Contains the parameters for ValidatePipelineDefinition.</p>
  */
 export interface ValidatePipelineDefinitionInput {
@@ -838,6 +899,7 @@ export interface ValidatePipelineDefinitionInput {
     parameterValues?: ParameterValue[];
 }
 /**
+ * @public
  * <p>Contains the output of ValidatePipelineDefinition.</p>
  */
 export interface ValidatePipelineDefinitionOutput {
@@ -854,207 +916,3 @@ export interface ValidatePipelineDefinitionOutput {
      */
     errored: boolean | undefined;
 }
-/**
- * @internal
- */
-export declare const ParameterValueFilterSensitiveLog: (obj: ParameterValue) => any;
-/**
- * @internal
- */
-export declare const ActivatePipelineInputFilterSensitiveLog: (obj: ActivatePipelineInput) => any;
-/**
- * @internal
- */
-export declare const ActivatePipelineOutputFilterSensitiveLog: (obj: ActivatePipelineOutput) => any;
-/**
- * @internal
- */
-export declare const TagFilterSensitiveLog: (obj: Tag) => any;
-/**
- * @internal
- */
-export declare const AddTagsInputFilterSensitiveLog: (obj: AddTagsInput) => any;
-/**
- * @internal
- */
-export declare const AddTagsOutputFilterSensitiveLog: (obj: AddTagsOutput) => any;
-/**
- * @internal
- */
-export declare const CreatePipelineInputFilterSensitiveLog: (obj: CreatePipelineInput) => any;
-/**
- * @internal
- */
-export declare const CreatePipelineOutputFilterSensitiveLog: (obj: CreatePipelineOutput) => any;
-/**
- * @internal
- */
-export declare const DeactivatePipelineInputFilterSensitiveLog: (obj: DeactivatePipelineInput) => any;
-/**
- * @internal
- */
-export declare const DeactivatePipelineOutputFilterSensitiveLog: (obj: DeactivatePipelineOutput) => any;
-/**
- * @internal
- */
-export declare const DeletePipelineInputFilterSensitiveLog: (obj: DeletePipelineInput) => any;
-/**
- * @internal
- */
-export declare const DescribeObjectsInputFilterSensitiveLog: (obj: DescribeObjectsInput) => any;
-/**
- * @internal
- */
-export declare const FieldFilterSensitiveLog: (obj: Field) => any;
-/**
- * @internal
- */
-export declare const PipelineObjectFilterSensitiveLog: (obj: PipelineObject) => any;
-/**
- * @internal
- */
-export declare const DescribeObjectsOutputFilterSensitiveLog: (obj: DescribeObjectsOutput) => any;
-/**
- * @internal
- */
-export declare const DescribePipelinesInputFilterSensitiveLog: (obj: DescribePipelinesInput) => any;
-/**
- * @internal
- */
-export declare const PipelineDescriptionFilterSensitiveLog: (obj: PipelineDescription) => any;
-/**
- * @internal
- */
-export declare const DescribePipelinesOutputFilterSensitiveLog: (obj: DescribePipelinesOutput) => any;
-/**
- * @internal
- */
-export declare const EvaluateExpressionInputFilterSensitiveLog: (obj: EvaluateExpressionInput) => any;
-/**
- * @internal
- */
-export declare const EvaluateExpressionOutputFilterSensitiveLog: (obj: EvaluateExpressionOutput) => any;
-/**
- * @internal
- */
-export declare const GetPipelineDefinitionInputFilterSensitiveLog: (obj: GetPipelineDefinitionInput) => any;
-/**
- * @internal
- */
-export declare const ParameterAttributeFilterSensitiveLog: (obj: ParameterAttribute) => any;
-/**
- * @internal
- */
-export declare const ParameterObjectFilterSensitiveLog: (obj: ParameterObject) => any;
-/**
- * @internal
- */
-export declare const GetPipelineDefinitionOutputFilterSensitiveLog: (obj: GetPipelineDefinitionOutput) => any;
-/**
- * @internal
- */
-export declare const ListPipelinesInputFilterSensitiveLog: (obj: ListPipelinesInput) => any;
-/**
- * @internal
- */
-export declare const PipelineIdNameFilterSensitiveLog: (obj: PipelineIdName) => any;
-/**
- * @internal
- */
-export declare const ListPipelinesOutputFilterSensitiveLog: (obj: ListPipelinesOutput) => any;
-/**
- * @internal
- */
-export declare const InstanceIdentityFilterSensitiveLog: (obj: InstanceIdentity) => any;
-/**
- * @internal
- */
-export declare const PollForTaskInputFilterSensitiveLog: (obj: PollForTaskInput) => any;
-/**
- * @internal
- */
-export declare const TaskObjectFilterSensitiveLog: (obj: TaskObject) => any;
-/**
- * @internal
- */
-export declare const PollForTaskOutputFilterSensitiveLog: (obj: PollForTaskOutput) => any;
-/**
- * @internal
- */
-export declare const PutPipelineDefinitionInputFilterSensitiveLog: (obj: PutPipelineDefinitionInput) => any;
-/**
- * @internal
- */
-export declare const ValidationErrorFilterSensitiveLog: (obj: ValidationError) => any;
-/**
- * @internal
- */
-export declare const ValidationWarningFilterSensitiveLog: (obj: ValidationWarning) => any;
-/**
- * @internal
- */
-export declare const PutPipelineDefinitionOutputFilterSensitiveLog: (obj: PutPipelineDefinitionOutput) => any;
-/**
- * @internal
- */
-export declare const OperatorFilterSensitiveLog: (obj: Operator) => any;
-/**
- * @internal
- */
-export declare const SelectorFilterSensitiveLog: (obj: Selector) => any;
-/**
- * @internal
- */
-export declare const QueryFilterSensitiveLog: (obj: Query) => any;
-/**
- * @internal
- */
-export declare const QueryObjectsInputFilterSensitiveLog: (obj: QueryObjectsInput) => any;
-/**
- * @internal
- */
-export declare const QueryObjectsOutputFilterSensitiveLog: (obj: QueryObjectsOutput) => any;
-/**
- * @internal
- */
-export declare const RemoveTagsInputFilterSensitiveLog: (obj: RemoveTagsInput) => any;
-/**
- * @internal
- */
-export declare const RemoveTagsOutputFilterSensitiveLog: (obj: RemoveTagsOutput) => any;
-/**
- * @internal
- */
-export declare const ReportTaskProgressInputFilterSensitiveLog: (obj: ReportTaskProgressInput) => any;
-/**
- * @internal
- */
-export declare const ReportTaskProgressOutputFilterSensitiveLog: (obj: ReportTaskProgressOutput) => any;
-/**
- * @internal
- */
-export declare const ReportTaskRunnerHeartbeatInputFilterSensitiveLog: (obj: ReportTaskRunnerHeartbeatInput) => any;
-/**
- * @internal
- */
-export declare const ReportTaskRunnerHeartbeatOutputFilterSensitiveLog: (obj: ReportTaskRunnerHeartbeatOutput) => any;
-/**
- * @internal
- */
-export declare const SetStatusInputFilterSensitiveLog: (obj: SetStatusInput) => any;
-/**
- * @internal
- */
-export declare const SetTaskStatusInputFilterSensitiveLog: (obj: SetTaskStatusInput) => any;
-/**
- * @internal
- */
-export declare const SetTaskStatusOutputFilterSensitiveLog: (obj: SetTaskStatusOutput) => any;
-/**
- * @internal
- */
-export declare const ValidatePipelineDefinitionInputFilterSensitiveLog: (obj: ValidatePipelineDefinitionInput) => any;
-/**
- * @internal
- */
-export declare const ValidatePipelineDefinitionOutputFilterSensitiveLog: (obj: ValidatePipelineDefinitionOutput) => any;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { DescribeObjectsCommandInput, DescribeObjectsCommandOutput } from "../commands/DescribeObjectsCommand";
 import { DataPipelinePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateDescribeObjects(config: DataPipelinePaginationConfiguration, input: DescribeObjectsCommandInput, ...additionalArguments: any): Paginator<DescribeObjectsCommandOutput>;

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

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

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListPipelinesCommandInput, ListPipelinesCommandOutput } from "../commands/ListPipelinesCommand";
 import { DataPipelinePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListPipelines(config: DataPipelinePaginationConfiguration, input: ListPipelinesCommandInput, ...additionalArguments: any): Paginator<ListPipelinesCommandOutput>;

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

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { QueryObjectsCommandInput, QueryObjectsCommandOutput } from "../commands/QueryObjectsCommand";
 import { DataPipelinePaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateQueryObjects(config: DataPipelinePaginationConfiguration, input: QueryObjectsCommandInput, ...additionalArguments: any): Paginator<QueryObjectsCommandOutput>;