AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AwsVpcConfiguration

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.

Class BatchArrayProperties

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

Class BatchContainerOverrides

The overrides that are sent to a container.

Class BatchEnvironmentVariable

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

Class BatchJobDependency

An object that represents an Batch job dependency.

Class BatchResourceRequirement

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

Class BatchRetryStrategy

The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

Class CapacityProviderStrategyItem

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

Class CloudwatchLogsLogDestination

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Class CloudwatchLogsLogDestinationParameters

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Class ConflictException

An action you attempted resulted in an exception.

Class CreatePipeRequest

Container for the parameters to the CreatePipe operation. Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

Class CreatePipeResponse

This is the response object from the CreatePipe operation.

Class DeadLetterConfig

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

Class DeletePipeRequest

Container for the parameters to the DeletePipe operation. Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Class DeletePipeResponse

This is the response object from the DeletePipe operation.

Class DescribePipeRequest

Container for the parameters to the DescribePipe operation. Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Class DescribePipeResponse

This is the response object from the DescribePipe operation.

Class DimensionMapping

Maps source data to a dimension in the target Timestream for LiveAnalytics table.

For more information, see Amazon Timestream for LiveAnalytics concepts

Class EcsContainerOverride

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

Class EcsEnvironmentFile

A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE format. Lines beginning with # are treated as comments and are ignored. For more information about the environment variable file syntax, see Declare default environment variables in file.

If there are environment variables specified using the environment parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

  • Linux platform version 1.4.0 or later.

  • Windows platform version 1.0.0 or later.

Class EcsEnvironmentVariable

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

Class EcsEphemeralStorage

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate. For more information, see Fargate task storage in the Amazon ECS User Guide for Fargate.

This parameter is only supported for tasks hosted on Fargate using Linux platform version 1.4.0 or later. This parameter is not supported for Windows containers on Fargate.

Class EcsInferenceAcceleratorOverride

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Class EcsResourceRequirement

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

Class EcsTaskOverride

The overrides that are associated with a task.

Class Filter

Filter events using an event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Class FilterCriteria

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.

Class FirehoseLogDestination

The Amazon Data Firehose logging configuration settings for the pipe.

Class FirehoseLogDestinationParameters

The Amazon Data Firehose logging configuration settings for the pipe.

Class InternalException

This exception occurs due to unexpected causes.

Class ListPipesRequest

Container for the parameters to the ListPipes operation. Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Class ListPipesResponse

This is the response object from the ListPipes operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Displays the tags associated with a pipe.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class MQBrokerAccessCredentials

The Secrets Manager secret that stores your broker credentials.

Class MSKAccessCredentials

The Secrets Manager secret that stores your stream credentials.

Class MultiMeasureAttributeMapping

A mapping of a source event data field to a measure in a Timestream for LiveAnalytics record.

Class MultiMeasureMapping

Maps multiple measures from the source event to the same Timestream for LiveAnalytics record.

For more information, see Amazon Timestream for LiveAnalytics concepts

Class NetworkConfiguration

This structure specifies the network configuration for an Amazon ECS task.

Class NotFoundException

An entity that you specified does not exist.

Class Pipe

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

Class PipeEnrichmentHttpParameters

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

Class PipeEnrichmentParameters

The parameters required to set up enrichment on your pipe.

Class PipeLogConfiguration

The logging configuration settings for the pipe.

Class PipeLogConfigurationParameters

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 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 Firehose stream log destination.

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

Class PipeSourceActiveMQBrokerParameters

The parameters for using an Active MQ broker as a source.

Class PipeSourceDynamoDBStreamParameters

The parameters for using a DynamoDB stream as a source.

Class PipeSourceKinesisStreamParameters

The parameters for using a Kinesis stream as a source.

Class PipeSourceManagedStreamingKafkaParameters

The parameters for using an MSK stream as a source.

Class PipeSourceParameters

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

Class PipeSourceRabbitMQBrokerParameters

The parameters for using a Rabbit MQ broker as a source.

Class PipeSourceSelfManagedKafkaParameters

The parameters for using a self-managed Apache Kafka stream as a source.

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

Class PipeSourceSqsQueueParameters

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

Class PipesPaginatorFactory

Paginators for the Pipes service

Class PipeTargetBatchJobParameters

The parameters for using an Batch job as a target.

Class PipeTargetCloudWatchLogsParameters

The parameters for using an CloudWatch Logs log stream as a target.

Class PipeTargetEcsTaskParameters

The parameters for using an Amazon ECS task as a target.

Class PipeTargetEventBridgeEventBusParameters

The parameters for using an EventBridge event bus as a target.

Class PipeTargetHttpParameters

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

Class PipeTargetKinesisStreamParameters

The parameters for using a Kinesis stream as a target.

Class PipeTargetLambdaFunctionParameters

The parameters for using a Lambda function as a target.

Class PipeTargetParameters

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.

Class PipeTargetRedshiftDataParameters

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

Class PipeTargetSageMakerPipelineParameters

The parameters for using a SageMaker pipeline as a target.

Class PipeTargetSqsQueueParameters

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

Class PipeTargetStateMachineParameters

The parameters for using a Step Functions state machine as a target.

Class PipeTargetTimestreamParameters

The parameters for using a Timestream for LiveAnalytics table as a target.

Class PlacementConstraint

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

Class PlacementStrategy

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.

Class S3LogDestination

The Amazon S3 logging configuration settings for the pipe.

Class S3LogDestinationParameters

The Amazon S3 logging configuration settings for the pipe.

Class SageMakerPipelineParameter

Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.

Class SelfManagedKafkaAccessConfigurationCredentials

The Secrets Manager secret that stores your stream credentials.

Class SelfManagedKafkaAccessConfigurationVpc

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

Class ServiceQuotaExceededException

A quota has been exceeded.

Class SingleMeasureMapping

Maps a single source data field to a single record in the specified Timestream for LiveAnalytics table.

For more information, see Amazon Timestream for LiveAnalytics concepts

Class StartPipeRequest

Container for the parameters to the StartPipe operation. Start an existing pipe.

Class StartPipeResponse

This is the response object from the StartPipe operation.

Class StopPipeRequest

Container for the parameters to the StopPipe operation. Stop an existing pipe.

Class StopPipeResponse

This is the response object from the StopPipe operation.

Class Tag

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Assigns one or more tags (key-value pairs) to the specified pipe. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a pipe that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the pipe. If you specify a tag key that is already associated with the pipe, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a pipe.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThrottlingException

An action was throttled.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes one or more tags from the specified pipes.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdatePipeRequest

Container for the parameters to the UpdatePipe operation. 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. 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.

Class UpdatePipeResponse

This is the response object from the UpdatePipe operation.

Class UpdatePipeSourceActiveMQBrokerParameters

The parameters for using an Active MQ broker as a source.

Class UpdatePipeSourceDynamoDBStreamParameters

The parameters for using a DynamoDB stream as a source.

Class UpdatePipeSourceKinesisStreamParameters

The parameters for using a Kinesis stream as a source.

Class UpdatePipeSourceManagedStreamingKafkaParameters

The parameters for using an MSK stream as a source.

Class UpdatePipeSourceParameters

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

Class UpdatePipeSourceRabbitMQBrokerParameters

The parameters for using a Rabbit MQ broker as a source.

Class UpdatePipeSourceSelfManagedKafkaParameters

The parameters for using a self-managed Apache Kafka stream as a source.

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

Class UpdatePipeSourceSqsQueueParameters

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

Class ValidationException

Indicates that an error has occurred while performing a validate operation.

Class ValidationExceptionField

Indicates that an error has occurred while performing a validate operation.

Interfaces

NameDescription
Interface IListPipesPaginator

Paginator for the ListPipes operation

Interface IPipesPaginatorFactory

Paginators for the Pipes service