diff --git a/clients/client-pipes/src/commands/CreatePipeCommand.ts b/clients/client-pipes/src/commands/CreatePipeCommand.ts index 17b8bde047301..c494510e3e91d 100644 --- a/clients/client-pipes/src/commands/CreatePipeCommand.ts +++ b/clients/client-pipes/src/commands/CreatePipeCommand.ts @@ -346,6 +346,24 @@ export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataB * Tags: { // TagMap * "": "STRING_VALUE", * }, + * LogConfiguration: { // PipeLogConfigurationParameters + * S3LogDestination: { // S3LogDestinationParameters + * BucketName: "STRING_VALUE", // required + * BucketOwner: "STRING_VALUE", // required + * OutputFormat: "STRING_VALUE", + * Prefix: "STRING_VALUE", + * }, + * FirehoseLogDestination: { // FirehoseLogDestinationParameters + * DeliveryStreamArn: "STRING_VALUE", // required + * }, + * CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestinationParameters + * LogGroupArn: "STRING_VALUE", // required + * }, + * Level: "STRING_VALUE", // required + * IncludeExecutionData: [ // IncludeExecutionData + * "STRING_VALUE", + * ], + * }, * }; * const command = new CreatePipeCommand(input); * const response = await client.send(command); diff --git a/clients/client-pipes/src/commands/DescribePipeCommand.ts b/clients/client-pipes/src/commands/DescribePipeCommand.ts index a77c199efe02d..1e9b1e24e92c4 100644 --- a/clients/client-pipes/src/commands/DescribePipeCommand.ts +++ b/clients/client-pipes/src/commands/DescribePipeCommand.ts @@ -356,6 +356,24 @@ export interface DescribePipeCommandOutput extends DescribePipeResponse, __Metad * // }, * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), + * // LogConfiguration: { // PipeLogConfiguration + * // S3LogDestination: { // S3LogDestination + * // BucketName: "STRING_VALUE", + * // Prefix: "STRING_VALUE", + * // BucketOwner: "STRING_VALUE", + * // OutputFormat: "STRING_VALUE", + * // }, + * // FirehoseLogDestination: { // FirehoseLogDestination + * // DeliveryStreamArn: "STRING_VALUE", + * // }, + * // CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestination + * // LogGroupArn: "STRING_VALUE", + * // }, + * // Level: "STRING_VALUE", + * // IncludeExecutionData: [ // IncludeExecutionData + * // "STRING_VALUE", + * // ], + * // }, * // }; * * ``` diff --git a/clients/client-pipes/src/commands/UpdatePipeCommand.ts b/clients/client-pipes/src/commands/UpdatePipeCommand.ts index e9154c4f9a500..facdbca7d868a 100644 --- a/clients/client-pipes/src/commands/UpdatePipeCommand.ts +++ b/clients/client-pipes/src/commands/UpdatePipeCommand.ts @@ -37,10 +37,11 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB /** * @public - *

Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. + *

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. * The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or - * TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that - * if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.

+ * TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. + * EventBridge updates the fields in these objects atomically as one and overrides existing values. + * This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.

*

For more information about pipes, see * Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

* @example @@ -332,6 +333,24 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB * }, * }, * RoleArn: "STRING_VALUE", // required + * LogConfiguration: { // PipeLogConfigurationParameters + * S3LogDestination: { // S3LogDestinationParameters + * BucketName: "STRING_VALUE", // required + * BucketOwner: "STRING_VALUE", // required + * OutputFormat: "STRING_VALUE", + * Prefix: "STRING_VALUE", + * }, + * FirehoseLogDestination: { // FirehoseLogDestinationParameters + * DeliveryStreamArn: "STRING_VALUE", // required + * }, + * CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestinationParameters + * LogGroupArn: "STRING_VALUE", // required + * }, + * Level: "STRING_VALUE", // required + * IncludeExecutionData: [ // IncludeExecutionData + * "STRING_VALUE", + * ], + * }, * }; * const command = new UpdatePipeCommand(input); * const response = await client.send(command); diff --git a/clients/client-pipes/src/models/models_0.ts b/clients/client-pipes/src/models/models_0.ts index 91aab96545c1b..4274f2f8f16b5 100644 --- a/clients/client-pipes/src/models/models_0.ts +++ b/clients/client-pipes/src/models/models_0.ts @@ -385,6 +385,30 @@ export interface CapacityProviderStrategyItem { base?: number; } +/** + * @public + *

The Amazon CloudWatch Logs logging configuration settings for the pipe.

+ */ +export interface CloudwatchLogsLogDestination { + /** + * @public + *

The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.

+ */ + LogGroupArn?: string; +} + +/** + * @public + *

The Amazon CloudWatch Logs logging configuration settings for the pipe.

+ */ +export interface CloudwatchLogsLogDestinationParameters { + /** + * @public + *

The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.

+ */ + LogGroupArn: string | undefined; +} + /** * @public *

An action you attempted resulted in an exception.

@@ -473,6 +497,7 @@ export interface PipeEnrichmentParameters { *

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is * passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data * Interchange Format.

+ *

To remove an input template, specify an empty string.

*/ InputTemplate?: string; @@ -489,6 +514,167 @@ export interface PipeEnrichmentParameters { HttpParameters?: PipeEnrichmentHttpParameters; } +/** + * @public + *

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

+ */ +export interface FirehoseLogDestinationParameters { + /** + * @public + *

Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

+ */ + DeliveryStreamArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const IncludeExecutionDataOption = { + ALL: "ALL", +} as const; + +/** + * @public + */ +export type IncludeExecutionDataOption = (typeof IncludeExecutionDataOption)[keyof typeof IncludeExecutionDataOption]; + +/** + * @public + * @enum + */ +export const LogLevel = { + ERROR: "ERROR", + INFO: "INFO", + OFF: "OFF", + TRACE: "TRACE", +} as const; + +/** + * @public + */ +export type LogLevel = (typeof LogLevel)[keyof typeof LogLevel]; + +/** + * @public + * @enum + */ +export const S3OutputFormat = { + JSON: "json", + PLAIN: "plain", + W3C: "w3c", +} as const; + +/** + * @public + */ +export type S3OutputFormat = (typeof S3OutputFormat)[keyof typeof S3OutputFormat]; + +/** + * @public + *

The Amazon S3 logging configuration settings for the pipe.

+ */ +export interface S3LogDestinationParameters { + /** + * @public + *

Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

+ */ + BucketName: string | undefined; + + /** + * @public + *

Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

+ */ + BucketOwner: string | undefined; + + /** + * @public + *

How EventBridge should format the log records.

+ * + */ + OutputFormat?: S3OutputFormat; + + /** + * @public + *

Specifies any prefix text with which to begin Amazon S3 log object names.

+ *

You can use prefixes to organize the data that you store in Amazon S3 buckets. + * A prefix is a string of characters at the beginning of the object key name. + * A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). + * For more information, see Organizing objects using prefixes + * in the Amazon Simple Storage Service User Guide.

+ */ + Prefix?: string; +} + +/** + * @public + *

Specifies the logging configuration settings for the pipe.

+ *

When you call UpdatePipe, EventBridge updates the fields in the + * PipeLogConfigurationParameters object atomically as one and overrides + * existing values. This is by design. If you don't specify an optional field in any of the + * Amazon Web Services service parameters objects + * (CloudwatchLogsLogDestinationParameters, + * FirehoseLogDestinationParameters, or + * S3LogDestinationParameters), EventBridge sets that field to its + * system-default value during the update.

+ *

For example, suppose when you created the pipe you + * specified a Kinesis Data Firehose stream log destination. You then update the pipe to add an + * Amazon S3 log destination. In addition to specifying the + * S3LogDestinationParameters for the new log destination, you must also + * specify the fields in the FirehoseLogDestinationParameters object in order to + * retain the Kinesis Data Firehose stream log destination.

+ *

For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.

+ */ +export interface PipeLogConfigurationParameters { + /** + * @public + *

The Amazon S3 logging configuration settings for the pipe.

+ */ + S3LogDestination?: S3LogDestinationParameters; + + /** + * @public + *

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

+ */ + FirehoseLogDestination?: FirehoseLogDestinationParameters; + + /** + * @public + *

The Amazon CloudWatch Logs logging configuration settings for the pipe.

+ */ + CloudwatchLogsLogDestination?: CloudwatchLogsLogDestinationParameters; + + /** + * @public + *

The level of logging detail to include. This applies to all log destinations for the pipe.

+ *

For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

+ */ + Level: LogLevel | undefined; + + /** + * @public + *

Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.

+ *

This applies to all log destinations for the pipe.

+ *

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

+ *

The default is OFF.

+ */ + IncludeExecutionData?: IncludeExecutionDataOption[]; +} + /** * @public *

The Secrets Manager secret that stores your broker credentials.

@@ -566,7 +752,9 @@ export interface PipeSourceActiveMQBrokerParameters { export interface DeadLetterConfig { /** * @public - *

The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.

+ *

The ARN of the specified target for the dead-letter queue.

+ *

For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify + * either an Amazon SNS topic or Amazon SQS queue ARN.

*/ Arn?: string; } @@ -672,7 +860,9 @@ export interface Filter { /** * @public - *

The collection of event patterns used to filter events. For more information, see Events and Event + *

The collection of event patterns used to filter events.

+ *

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

+ *

For more information, see Events and Event * Patterns in the Amazon EventBridge User Guide.

*/ export interface FilterCriteria { @@ -1120,7 +1310,9 @@ export interface PipeSourceSqsQueueParameters { export interface PipeSourceParameters { /** * @public - *

The collection of event patterns used to filter events. For more information, see Events and Event + *

The collection of event patterns used to filter events.

+ *

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

+ *

For more information, see Events and Event * Patterns in the Amazon EventBridge User Guide.

*/ FilterCriteria?: FilterCriteria; @@ -1799,9 +1991,6 @@ export interface PipeTargetEventBridgeEventBusParameters { /** * @public *

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

- * - *

When using Java, you must include auth-crt on the class path.

- * */ EndpointId?: string; @@ -1861,7 +2050,7 @@ export interface PipeTargetHttpParameters { /** * @public - *

The parameters for using a Kinesis stream as a source.

+ *

The parameters for using a Kinesis stream as a target.

*/ export interface PipeTargetKinesisStreamParameters { /** @@ -1895,25 +2084,18 @@ export type PipeTargetInvocationType = (typeof PipeTargetInvocationType)[keyof t export interface PipeTargetLambdaFunctionParameters { /** * @public - *

Choose from the following options.

+ *

Specify whether to invoke the function synchronously or asynchronously.

* + *

For more information, see Invocation types in the Amazon EventBridge User Guide.

*/ InvocationType?: PipeTargetInvocationType; } @@ -1921,13 +2103,13 @@ export interface PipeTargetLambdaFunctionParameters { /** * @public *

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the - * Amazon Redshift Data API ExecuteStatement.

+ * Amazon Redshift Data API BatchExecuteStatement.

*/ export interface PipeTargetRedshiftDataParameters { /** * @public *

The name or ARN of the secret that enables access to the database. Required when - * authenticating using SageMaker.

+ * authenticating using Secrets Manager.

*/ SecretManagerArn?: string; @@ -1997,7 +2179,7 @@ export interface PipeTargetSageMakerPipelineParameters { /** * @public - *

The parameters for using a Amazon SQS stream as a source.

+ *

The parameters for using a Amazon SQS stream as a target.

*/ export interface PipeTargetSqsQueueParameters { /** @@ -2021,7 +2203,22 @@ export interface PipeTargetSqsQueueParameters { export interface PipeTargetStateMachineParameters { /** * @public - *

Specify whether to wait for the state machine to finish or not.

+ *

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

+ * + *

For more information, see Invocation types in the Amazon EventBridge User Guide.

*/ InvocationType?: PipeTargetInvocationType; } @@ -2029,6 +2226,7 @@ export interface PipeTargetStateMachineParameters { /** * @public *

The parameters required to set up a target for your pipe.

+ *

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

*/ export interface PipeTargetParameters { /** @@ -2036,6 +2234,7 @@ export interface PipeTargetParameters { *

Valid JSON text passed to the target. In this case, nothing from the event itself is * passed to the target. For more information, see The JavaScript Object Notation (JSON) Data * Interchange Format.

+ *

To remove an input template, specify an empty string.

*/ InputTemplate?: string; @@ -2053,7 +2252,7 @@ export interface PipeTargetParameters { /** * @public - *

The parameters for using a Kinesis stream as a source.

+ *

The parameters for using a Kinesis stream as a target.

*/ KinesisStreamParameters?: PipeTargetKinesisStreamParameters; @@ -2071,7 +2270,7 @@ export interface PipeTargetParameters { /** * @public - *

The parameters for using a Amazon SQS stream as a source.

+ *

The parameters for using a Amazon SQS stream as a target.

*/ SqsQueueParameters?: PipeTargetSqsQueueParameters; @@ -2085,7 +2284,7 @@ export interface PipeTargetParameters { /** * @public *

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the - * Amazon Redshift Data API ExecuteStatement.

+ * Amazon Redshift Data API BatchExecuteStatement.

*/ RedshiftDataParameters?: PipeTargetRedshiftDataParameters; @@ -2163,6 +2362,7 @@ export interface CreatePipeRequest { /** * @public *

The parameters required to set up a target for your pipe.

+ *

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

*/ TargetParameters?: PipeTargetParameters; @@ -2177,6 +2377,12 @@ export interface CreatePipeRequest { *

The list of key-value pairs to associate with the pipe.

*/ Tags?: Record; + + /** + * @public + *

The logging configuration settings for the pipe.

+ */ + LogConfiguration?: PipeLogConfigurationParameters; } /** @@ -2185,7 +2391,10 @@ export interface CreatePipeRequest { */ export const PipeState = { CREATE_FAILED: "CREATE_FAILED", + CREATE_ROLLBACK_FAILED: "CREATE_ROLLBACK_FAILED", CREATING: "CREATING", + DELETE_FAILED: "DELETE_FAILED", + DELETE_ROLLBACK_FAILED: "DELETE_ROLLBACK_FAILED", DELETING: "DELETING", RUNNING: "RUNNING", STARTING: "STARTING", @@ -2194,6 +2403,7 @@ export const PipeState = { STOPPING: "STOPPING", STOP_FAILED: "STOP_FAILED", UPDATE_FAILED: "UPDATE_FAILED", + UPDATE_ROLLBACK_FAILED: "UPDATE_ROLLBACK_FAILED", UPDATING: "UPDATING", } as const; @@ -2503,6 +2713,103 @@ export interface DescribePipeRequest { Name: string | undefined; } +/** + * @public + *

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

+ */ +export interface FirehoseLogDestination { + /** + * @public + *

The Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

+ */ + DeliveryStreamArn?: string; +} + +/** + * @public + *

The Amazon S3 logging configuration settings for the pipe.

+ */ +export interface S3LogDestination { + /** + * @public + *

The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

+ */ + BucketName?: string; + + /** + * @public + *

The prefix text with which to begin Amazon S3 log object names.

+ *

For more information, see Organizing objects using prefixes + * in the Amazon Simple Storage Service User Guide.

+ */ + Prefix?: string; + + /** + * @public + *

The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

+ */ + BucketOwner?: string; + + /** + * @public + *

The format EventBridge uses for the log records.

+ * + */ + OutputFormat?: S3OutputFormat; +} + +/** + * @public + *

The logging configuration settings for the pipe.

+ */ +export interface PipeLogConfiguration { + /** + * @public + *

The Amazon S3 logging configuration settings for the pipe.

+ */ + S3LogDestination?: S3LogDestination; + + /** + * @public + *

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

+ */ + FirehoseLogDestination?: FirehoseLogDestination; + + /** + * @public + *

The Amazon CloudWatch Logs logging configuration settings for the pipe.

+ */ + CloudwatchLogsLogDestination?: CloudwatchLogsLogDestination; + + /** + * @public + *

The level of logging detail to include. This applies to all log destinations for the pipe.

+ */ + Level?: LogLevel; + + /** + * @public + *

Whether the execution data (specifically, the payload, awsRequest, and awsResponse fields) is included in the log messages for this pipe.

+ *

This applies to all log destinations for the pipe.

+ *

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

+ */ + IncludeExecutionData?: IncludeExecutionDataOption[]; +} + /** * @public */ @@ -2576,6 +2883,7 @@ export interface DescribePipeResponse { /** * @public *

The parameters required to set up a target for your pipe.

+ *

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

*/ TargetParameters?: PipeTargetParameters; @@ -2602,6 +2910,12 @@ export interface DescribePipeResponse { *

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

*/ LastModifiedTime?: Date; + + /** + * @public + *

The logging configuration settings for the pipe.

+ */ + LogConfiguration?: PipeLogConfiguration; } /** @@ -3100,7 +3414,9 @@ export interface UpdatePipeSourceSqsQueueParameters { export interface UpdatePipeSourceParameters { /** * @public - *

The collection of event patterns used to filter events. For more information, see Events and Event + *

The collection of event patterns used to filter events.

+ *

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

+ *

For more information, see Events and Event * Patterns in the Amazon EventBridge User Guide.

*/ FilterCriteria?: FilterCriteria; @@ -3197,6 +3513,7 @@ export interface UpdatePipeRequest { /** * @public *

The parameters required to set up a target for your pipe.

+ *

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

*/ TargetParameters?: PipeTargetParameters; @@ -3205,6 +3522,12 @@ export interface UpdatePipeRequest { *

The ARN of the role that allows the pipe to send data to the target.

*/ RoleArn: string | undefined; + + /** + * @public + *

The logging configuration settings for the pipe.

+ */ + LogConfiguration?: PipeLogConfigurationParameters; } /** diff --git a/clients/client-pipes/src/protocols/Aws_restJson1.ts b/clients/client-pipes/src/protocols/Aws_restJson1.ts index d6d0686348ba7..c1874f3cbde40 100644 --- a/clients/client-pipes/src/protocols/Aws_restJson1.ts +++ b/clients/client-pipes/src/protocols/Aws_restJson1.ts @@ -45,6 +45,7 @@ import { BatchResourceRequirement, BatchRetryStrategy, CapacityProviderStrategyItem, + CloudwatchLogsLogDestinationParameters, ConflictException, DeadLetterConfig, EcsContainerOverride, @@ -56,6 +57,8 @@ import { EcsTaskOverride, Filter, FilterCriteria, + FirehoseLogDestinationParameters, + IncludeExecutionDataOption, InternalException, MQBrokerAccessCredentials, MSKAccessCredentials, @@ -64,6 +67,7 @@ import { Pipe, PipeEnrichmentHttpParameters, PipeEnrichmentParameters, + PipeLogConfigurationParameters, PipeSourceActiveMQBrokerParameters, PipeSourceDynamoDBStreamParameters, PipeSourceKinesisStreamParameters, @@ -86,6 +90,7 @@ import { PipeTargetStateMachineParameters, PlacementConstraint, PlacementStrategy, + S3LogDestinationParameters, SageMakerPipelineParameter, SelfManagedKafkaAccessConfigurationCredentials, SelfManagedKafkaAccessConfigurationVpc, @@ -124,6 +129,7 @@ export const se_CreatePipeCommand = async ( DesiredState: [], Enrichment: [], EnrichmentParameters: (_) => _json(_), + LogConfiguration: (_) => _json(_), RoleArn: [], Source: [], SourceParameters: (_) => se_PipeSourceParameters(_, context), @@ -370,6 +376,7 @@ export const se_UpdatePipeCommand = async ( DesiredState: [], Enrichment: [], EnrichmentParameters: (_) => _json(_), + LogConfiguration: (_) => _json(_), RoleArn: [], SourceParameters: (_) => _json(_), Target: [], @@ -541,6 +548,7 @@ export const de_DescribePipeCommand = async ( Enrichment: __expectString, EnrichmentParameters: _json, LastModifiedTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + LogConfiguration: _json, Name: __expectString, RoleArn: __expectString, Source: __expectString, @@ -1137,6 +1145,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_CapacityProviderStrategyItem omitted. +// se_CloudwatchLogsLogDestinationParameters omitted. + // se_DeadLetterConfig omitted. // se_EcsContainerOverride omitted. @@ -1171,8 +1181,12 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_FilterList omitted. +// se_FirehoseLogDestinationParameters omitted. + // se_HeaderParametersMap omitted. +// se_IncludeExecutionData omitted. + // se_KafkaBootstrapServers omitted. // se_MQBrokerAccessCredentials omitted. @@ -1187,6 +1201,8 @@ const de_ValidationExceptionRes = async (parsedOutput: any, context: __SerdeCont // se_PipeEnrichmentParameters omitted. +// se_PipeLogConfigurationParameters omitted. + // se_PipeSourceActiveMQBrokerParameters omitted. // se_PipeSourceDynamoDBStreamParameters omitted. @@ -1269,6 +1285,8 @@ const se_PipeSourceParameters = (input: PipeSourceParameters, context: __SerdeCo // se_QueryStringParametersMap omitted. +// se_S3LogDestinationParameters omitted. + // se_SageMakerPipelineParameter omitted. // se_SageMakerPipelineParameterList omitted. @@ -1337,6 +1355,8 @@ const se_PipeSourceParameters = (input: PipeSourceParameters, context: __SerdeCo // de_CapacityProviderStrategyItem omitted. +// de_CloudwatchLogsLogDestination omitted. + // de_DeadLetterConfig omitted. // de_EcsContainerOverride omitted. @@ -1371,8 +1391,12 @@ const se_PipeSourceParameters = (input: PipeSourceParameters, context: __SerdeCo // de_FilterList omitted. +// de_FirehoseLogDestination omitted. + // de_HeaderParametersMap omitted. +// de_IncludeExecutionData omitted. + // de_KafkaBootstrapServers omitted. // de_MQBrokerAccessCredentials omitted. @@ -1417,6 +1441,8 @@ const de_PipeList = (output: any, context: __SerdeContext): Pipe[] => { return retVal; }; +// de_PipeLogConfiguration omitted. + // de_PipeSourceActiveMQBrokerParameters omitted. // de_PipeSourceDynamoDBStreamParameters omitted. @@ -1499,6 +1525,8 @@ const de_PipeSourceParameters = (output: any, context: __SerdeContext): PipeSour // de_QueryStringParametersMap omitted. +// de_S3LogDestination omitted. + // de_SageMakerPipelineParameter omitted. // de_SageMakerPipelineParameterList omitted. diff --git a/codegen/sdk-codegen/aws-models/pipes.json b/codegen/sdk-codegen/aws-models/pipes.json index 7067463cafcef..515f88dece676 100644 --- a/codegen/sdk-codegen/aws-models/pipes.json +++ b/codegen/sdk-codegen/aws-models/pipes.json @@ -361,6 +361,45 @@ } } }, + "com.amazonaws.pipes#CloudwatchLogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:logs:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):log-group:.+)$" + } + }, + "com.amazonaws.pipes#CloudwatchLogsLogDestination": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.pipes#CloudwatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#CloudwatchLogsLogDestinationParameters": { + "type": "structure", + "members": { + "LogGroupArn": { + "target": "com.amazonaws.pipes#CloudwatchLogGroupArn", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, "com.amazonaws.pipes#ConflictException": { "type": "structure", "members": { @@ -490,7 +529,7 @@ "TargetParameters": { "target": "com.amazonaws.pipes#PipeTargetParameters", "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "RoleArn": { @@ -505,6 +544,13 @@ "traits": { "smithy.api#documentation": "

The list of key-value pairs to associate with the pipe.

" } + }, + "LogConfiguration": { + "target": "com.amazonaws.pipes#PipeLogConfigurationParameters", + "traits": { + "aws.cloudformation#cfnMutability": "write", + "smithy.api#documentation": "

The logging configuration settings for the pipe.

" + } } }, "traits": { @@ -583,7 +629,7 @@ "Arn": { "target": "com.amazonaws.pipes#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon SQS queue specified as the target for the dead-letter queue.

" + "smithy.api#documentation": "

The ARN of the specified target for the dead-letter queue.

\n

For Amazon Kinesis stream and Amazon DynamoDB stream sources, specify\n either an Amazon SNS topic or Amazon SQS queue ARN.

" } } }, @@ -812,7 +858,7 @@ "TargetParameters": { "target": "com.amazonaws.pipes#PipeTargetParameters", "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "RoleArn": { @@ -838,6 +884,13 @@ "traits": { "smithy.api#documentation": "

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" } + }, + "LogConfiguration": { + "target": "com.amazonaws.pipes#PipeLogConfiguration", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "

The logging configuration settings for the pipe.

" + } } }, "traits": { @@ -1224,7 +1277,7 @@ } }, "traits": { - "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The collection of event patterns used to filter events.

\n

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

\n

For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#FilterList": { @@ -1239,6 +1292,45 @@ } } }, + "com.amazonaws.pipes#FirehoseArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^(^arn:aws([a-z]|\\-)*:firehose:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}):(\\d{12}):deliverystream/.+)$" + } + }, + "com.amazonaws.pipes#FirehoseLogDestination": { + "type": "structure", + "members": { + "DeliveryStreamArn": { + "target": "com.amazonaws.pipes#FirehoseArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#FirehoseLogDestinationParameters": { + "type": "structure", + "members": { + "DeliveryStreamArn": { + "target": "com.amazonaws.pipes#FirehoseArn", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the Kinesis Data Firehose delivery stream to which EventBridge delivers the pipe log records.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, "com.amazonaws.pipes#HeaderKey": { "type": "string", "traits": { @@ -1269,6 +1361,26 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.pipes#IncludeExecutionData": { + "type": "list", + "member": { + "target": "com.amazonaws.pipes#IncludeExecutionDataOption" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.pipes#IncludeExecutionDataOption": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, "com.amazonaws.pipes#InputTemplate": { "type": "string", "traits": { @@ -1595,6 +1707,29 @@ } } }, + "com.amazonaws.pipes#LogLevel": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OFF", + "name": "OFF" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "INFO", + "name": "INFO" + }, + { + "value": "TRACE", + "name": "TRACE" + } + ] + } + }, "com.amazonaws.pipes#LogStreamName": { "type": "string", "traits": { @@ -1780,12 +1915,6 @@ "type": "list", "member": { "target": "com.amazonaws.pipes#PathParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } } }, "com.amazonaws.pipes#Pipe": { @@ -1910,7 +2039,7 @@ "InputTemplate": { "target": "com.amazonaws.pipes#InputTemplate", "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is\n passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

" + "smithy.api#documentation": "

Valid JSON text passed to the enrichment. In this case, nothing from the event itself is\n passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

\n

To remove an input template, specify an empty string.

" } }, "HttpParameters": { @@ -1930,6 +2059,83 @@ "target": "com.amazonaws.pipes#Pipe" } }, + "com.amazonaws.pipes#PipeLogConfiguration": { + "type": "structure", + "members": { + "S3LogDestination": { + "target": "com.amazonaws.pipes#S3LogDestination", + "traits": { + "smithy.api#documentation": "

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "FirehoseLogDestination": { + "target": "com.amazonaws.pipes#FirehoseLogDestination", + "traits": { + "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, + "CloudwatchLogsLogDestination": { + "target": "com.amazonaws.pipes#CloudwatchLogsLogDestination", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, + "Level": { + "target": "com.amazonaws.pipes#LogLevel", + "traits": { + "smithy.api#documentation": "

The level of logging detail to include. This applies to all log destinations for the pipe.

" + } + }, + "IncludeExecutionData": { + "target": "com.amazonaws.pipes#IncludeExecutionData", + "traits": { + "smithy.api#documentation": "

Whether the execution data (specifically, the payload, awsRequest, and awsResponse fields) is included in the log messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#PipeLogConfigurationParameters": { + "type": "structure", + "members": { + "S3LogDestination": { + "target": "com.amazonaws.pipes#S3LogDestinationParameters", + "traits": { + "smithy.api#documentation": "

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "FirehoseLogDestination": { + "target": "com.amazonaws.pipes#FirehoseLogDestinationParameters", + "traits": { + "smithy.api#documentation": "

The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

" + } + }, + "CloudwatchLogsLogDestination": { + "target": "com.amazonaws.pipes#CloudwatchLogsLogDestinationParameters", + "traits": { + "smithy.api#documentation": "

The Amazon CloudWatch Logs logging configuration settings for the pipe.

" + } + }, + "Level": { + "target": "com.amazonaws.pipes#LogLevel", + "traits": { + "smithy.api#documentation": "

The level of logging detail to include. This applies to all log destinations for the pipe.

\n

For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

", + "smithy.api#required": {} + } + }, + "IncludeExecutionData": { + "target": "com.amazonaws.pipes#IncludeExecutionData", + "traits": { + "smithy.api#documentation": "

Specify ON to include the execution data (specifically, the payload and awsRequest fields) in the log messages for this pipe.

\n

This applies to all log destinations for the pipe.

\n

For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

\n

The default is OFF.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the logging configuration settings for the pipe.

\n

When you call UpdatePipe, EventBridge updates the fields in the\n PipeLogConfigurationParameters object atomically as one and overrides\n existing values. This is by design. If you don't specify an optional field in any of the\n Amazon Web Services service parameters objects\n (CloudwatchLogsLogDestinationParameters,\n FirehoseLogDestinationParameters, or\n S3LogDestinationParameters), EventBridge sets that field to its\n system-default value during the update.

\n

For example, suppose when you created the pipe you\n specified a Kinesis Data Firehose stream log destination. You then update the pipe to add an\n Amazon S3 log destination. In addition to specifying the\n S3LogDestinationParameters for the new log destination, you must also\n specify the fields in the FirehoseLogDestinationParameters object in order to\n retain the Kinesis Data Firehose stream log destination.

\n

For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.

" + } + }, "com.amazonaws.pipes#PipeName": { "type": "string", "traits": { @@ -2190,7 +2396,7 @@ "FilterCriteria": { "target": "com.amazonaws.pipes#FilterCriteria", "traits": { - "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The collection of event patterns used to filter events.

\n

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

\n

For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "KinesisStreamParameters": { @@ -2410,6 +2616,22 @@ { "value": "STOP_FAILED", "name": "STOP_FAILED" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + }, + { + "value": "CREATE_ROLLBACK_FAILED", + "name": "CREATE_ROLLBACK_FAILED" + }, + { + "value": "DELETE_ROLLBACK_FAILED", + "name": "DELETE_ROLLBACK_FAILED" + }, + { + "value": "UPDATE_ROLLBACK_FAILED", + "name": "UPDATE_ROLLBACK_FAILED" } ] } @@ -2603,7 +2825,7 @@ "EndpointId": { "target": "com.amazonaws.pipes#EventBridgeEndpointId", "traits": { - "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

\n \n

When using Java, you must include auth-crt on the class path.

\n " + "smithy.api#documentation": "

The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.

" } }, "DetailType": { @@ -2688,7 +2910,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters for using a Kinesis stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Kinesis stream as a target.

" } }, "com.amazonaws.pipes#PipeTargetLambdaFunctionParameters": { @@ -2697,7 +2919,7 @@ "InvocationType": { "target": "com.amazonaws.pipes#PipeTargetInvocationType", "traits": { - "smithy.api#documentation": "

Choose from the following options.

\n " + "smithy.api#documentation": "

Specify whether to invoke the function synchronously or asynchronously.

\n \n

For more information, see Invocation types in the Amazon EventBridge User Guide.

" } } }, @@ -2711,7 +2933,7 @@ "InputTemplate": { "target": "com.amazonaws.pipes#InputTemplate", "traits": { - "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

" + "smithy.api#documentation": "

Valid JSON text passed to the target. In this case, nothing from the event itself is\n passed to the target. For more information, see The JavaScript Object Notation (JSON) Data\n Interchange Format.

\n

To remove an input template, specify an empty string.

" } }, "LambdaFunctionParameters": { @@ -2729,7 +2951,7 @@ "KinesisStreamParameters": { "target": "com.amazonaws.pipes#PipeTargetKinesisStreamParameters", "traits": { - "smithy.api#documentation": "

The parameters for using a Kinesis stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Kinesis stream as a target.

" } }, "EcsTaskParameters": { @@ -2747,7 +2969,7 @@ "SqsQueueParameters": { "target": "com.amazonaws.pipes#PipeTargetSqsQueueParameters", "traits": { - "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a target.

" } }, "HttpParameters": { @@ -2759,7 +2981,7 @@ "RedshiftDataParameters": { "target": "com.amazonaws.pipes#PipeTargetRedshiftDataParameters", "traits": { - "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement.

" + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API BatchExecuteStatement.

" } }, "SageMakerPipelineParameters": { @@ -2782,7 +3004,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "com.amazonaws.pipes#PipeTargetRedshiftDataParameters": { @@ -2791,7 +3013,7 @@ "SecretManagerArn": { "target": "com.amazonaws.pipes#SecretManagerArnOrJsonPath", "traits": { - "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using SageMaker.

" + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using Secrets Manager.

" } }, "Database": { @@ -2829,7 +3051,7 @@ } }, "traits": { - "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement.

" + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API BatchExecuteStatement.

" } }, "com.amazonaws.pipes#PipeTargetSageMakerPipelineParameters": { @@ -2863,7 +3085,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a source.

" + "smithy.api#documentation": "

The parameters for using a Amazon SQS stream as a target.

" } }, "com.amazonaws.pipes#PipeTargetStateMachineParameters": { @@ -2872,7 +3094,7 @@ "InvocationType": { "target": "com.amazonaws.pipes#PipeTargetInvocationType", "traits": { - "smithy.api#documentation": "

Specify whether to wait for the state machine to finish or not.

" + "smithy.api#documentation": "

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

\n \n

For more information, see Invocation types in the Amazon EventBridge User Guide.

" } } }, @@ -3847,6 +4069,99 @@ "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z0-9+=,.@\\-_/]+$" } }, + "com.amazonaws.pipes#S3LogDestination": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

" + } + }, + "Prefix": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The prefix text with which to begin Amazon S3 log object names.

\n

For more information, see Organizing objects using prefixes\n in the Amazon Simple Storage Service User Guide.

" + } + }, + "BucketOwner": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

" + } + }, + "OutputFormat": { + "target": "com.amazonaws.pipes#S3OutputFormat", + "traits": { + "smithy.api#documentation": "

The format EventBridge uses for the log records.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#S3LogDestinationParameters": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

", + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#required": {} + } + }, + "BucketOwner": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

", + "smithy.api#pattern": "^\\d{12}$", + "smithy.api#required": {} + } + }, + "OutputFormat": { + "target": "com.amazonaws.pipes#S3OutputFormat", + "traits": { + "smithy.api#documentation": "

How EventBridge should format the log records.

\n " + } + }, + "Prefix": { + "target": "com.amazonaws.pipes#String", + "traits": { + "smithy.api#documentation": "

Specifies any prefix text with which to begin Amazon S3 log object names.

\n

You can use prefixes to organize the data that you store in Amazon S3 buckets. \n A prefix is a string of characters at the beginning of the object key name. \n A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). \n For more information, see Organizing objects using prefixes\n in the Amazon Simple Storage Service User Guide.

", + "smithy.api#length": { + "max": 256 + } + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 logging configuration settings for the pipe.

" + } + }, + "com.amazonaws.pipes#S3OutputFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "json", + "name": "JSON" + }, + { + "value": "plain", + "name": "PLAIN" + }, + { + "value": "w3c", + "name": "W3C" + } + ] + } + }, "com.amazonaws.pipes#SageMakerPipelineParameter": { "type": "structure", "members": { @@ -4101,7 +4416,8 @@ "traits": { "smithy.api#documentation": "// A list of SQLs.", "smithy.api#length": { - "min": 1 + "min": 1, + "max": 40 } } }, @@ -4646,7 +4962,7 @@ "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a pipe", "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}", "aws:RequestTag/${TagKey}", "aws:TagKeys"], - "smithy.api#documentation": "

Update an existing pipe. When you call UpdatePipe, only the fields that are included in the request are changed, the rest are unchanged. \n The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or \n TargetParameters objects. The fields in these objects are updated atomically as one and override existing values. This is by design and means that \n if you don't specify an optional field in one of these Parameters objects, that field will be set to its system-default value after the update.

\n

For more information about pipes, see \n Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", + "smithy.api#documentation": "

Update an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged.\n The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or \n TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. \n EventBridge updates the fields in these objects atomically as one and overrides existing values. \n This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update.

\n

For more information about pipes, see \n Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/pipes/{Name}", @@ -4706,7 +5022,7 @@ "TargetParameters": { "target": "com.amazonaws.pipes#PipeTargetParameters", "traits": { - "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

" + "smithy.api#documentation": "

The parameters required to set up a target for your pipe.

\n

For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.

" } }, "RoleArn": { @@ -4715,6 +5031,13 @@ "smithy.api#documentation": "

The ARN of the role that allows the pipe to send data to the target.

", "smithy.api#required": {} } + }, + "LogConfiguration": { + "target": "com.amazonaws.pipes#PipeLogConfigurationParameters", + "traits": { + "aws.cloudformation#cfnMutability": "write", + "smithy.api#documentation": "

The logging configuration settings for the pipe.

" + } } }, "traits": { @@ -4924,7 +5247,7 @@ "FilterCriteria": { "target": "com.amazonaws.pipes#FilterCriteria", "traits": { - "smithy.api#documentation": "

The collection of event patterns used to filter events. For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" + "smithy.api#documentation": "

The collection of event patterns used to filter events.

\n

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

\n

For more information, see Events and Event\n Patterns in the Amazon EventBridge User Guide.

" } }, "KinesisStreamParameters": {