Amazonka.Pipes.Lens

Operations

CreatePipe

createPipe_description :: Lens' CreatePipe (Maybe Text)

A description of the pipe.

createPipe_desiredState :: Lens' CreatePipe (Maybe RequestedPipeState)

The state the pipe should be in.

createPipe_enrichment :: Lens' CreatePipe (Maybe Text)

The ARN of the enrichment resource.

createPipe_enrichmentParameters :: Lens' CreatePipe (Maybe PipeEnrichmentParameters)

The parameters required to set up enrichment on your pipe.

createPipe_sourceParameters :: Lens' CreatePipe (Maybe PipeSourceParameters)

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

createPipe_tags :: Lens' CreatePipe (Maybe (HashMap Text Text))

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

createPipe_targetParameters :: Lens' CreatePipe (Maybe PipeTargetParameters)

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

createPipe_name :: Lens' CreatePipe Text

The name of the pipe.

createPipe_roleArn :: Lens' CreatePipe Text

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

createPipe_source :: Lens' CreatePipe Text

The ARN of the source resource.

createPipe_target :: Lens' CreatePipe Text

The ARN of the target resource.

createPipeResponse_arn :: Lens' CreatePipeResponse (Maybe Text)

The ARN of the pipe.

createPipeResponse_creationTime :: Lens' CreatePipeResponse (Maybe UTCTime)

The time the pipe was created.

createPipeResponse_currentState :: Lens' CreatePipeResponse (Maybe PipeState)

The state the pipe is in.

createPipeResponse_desiredState :: Lens' CreatePipeResponse (Maybe RequestedPipeState)

The state the pipe should be in.

createPipeResponse_lastModifiedTime :: Lens' CreatePipeResponse (Maybe UTCTime)

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

createPipeResponse_name :: Lens' CreatePipeResponse (Maybe Text)

The name of the pipe.

createPipeResponse_httpStatus :: Lens' CreatePipeResponse Int

The response's http status code.

DeletePipe

deletePipe_name :: Lens' DeletePipe Text

The name of the pipe.

deletePipeResponse_arn :: Lens' DeletePipeResponse (Maybe Text)

The ARN of the pipe.

deletePipeResponse_creationTime :: Lens' DeletePipeResponse (Maybe UTCTime)

The time the pipe was created.

deletePipeResponse_currentState :: Lens' DeletePipeResponse (Maybe PipeState)

The state the pipe is in.

deletePipeResponse_desiredState :: Lens' DeletePipeResponse (Maybe RequestedPipeStateDescribeResponse)

The state the pipe should be in.

deletePipeResponse_lastModifiedTime :: Lens' DeletePipeResponse (Maybe UTCTime)

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

deletePipeResponse_name :: Lens' DeletePipeResponse (Maybe Text)

The name of the pipe.

deletePipeResponse_httpStatus :: Lens' DeletePipeResponse Int

The response's http status code.

DescribePipe

describePipe_name :: Lens' DescribePipe Text

The name of the pipe.

describePipeResponse_arn :: Lens' DescribePipeResponse (Maybe Text)

The ARN of the pipe.

describePipeResponse_creationTime :: Lens' DescribePipeResponse (Maybe UTCTime)

The time the pipe was created.

describePipeResponse_currentState :: Lens' DescribePipeResponse (Maybe PipeState)

The state the pipe is in.

describePipeResponse_description :: Lens' DescribePipeResponse (Maybe Text)

A description of the pipe.

describePipeResponse_desiredState :: Lens' DescribePipeResponse (Maybe RequestedPipeStateDescribeResponse)

The state the pipe should be in.

describePipeResponse_enrichment :: Lens' DescribePipeResponse (Maybe Text)

The ARN of the enrichment resource.

describePipeResponse_enrichmentParameters :: Lens' DescribePipeResponse (Maybe PipeEnrichmentParameters)

The parameters required to set up enrichment on your pipe.

describePipeResponse_lastModifiedTime :: Lens' DescribePipeResponse (Maybe UTCTime)

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

describePipeResponse_name :: Lens' DescribePipeResponse (Maybe Text)

The name of the pipe.

describePipeResponse_roleArn :: Lens' DescribePipeResponse (Maybe Text)

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

describePipeResponse_source :: Lens' DescribePipeResponse (Maybe Text)

The ARN of the source resource.

describePipeResponse_sourceParameters :: Lens' DescribePipeResponse (Maybe PipeSourceParameters)

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

describePipeResponse_stateReason :: Lens' DescribePipeResponse (Maybe Text)

The reason the pipe is in its current state.

describePipeResponse_tags :: Lens' DescribePipeResponse (Maybe (HashMap Text Text))

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

describePipeResponse_target :: Lens' DescribePipeResponse (Maybe Text)

The ARN of the target resource.

describePipeResponse_targetParameters :: Lens' DescribePipeResponse (Maybe PipeTargetParameters)

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

describePipeResponse_httpStatus :: Lens' DescribePipeResponse Int

The response's http status code.

ListPipes

listPipes_currentState :: Lens' ListPipes (Maybe PipeState)

The state the pipe is in.

listPipes_desiredState :: Lens' ListPipes (Maybe RequestedPipeState)

The state the pipe should be in.

listPipes_limit :: Lens' ListPipes (Maybe Natural)

The maximum number of pipes to include in the response.

listPipes_namePrefix :: Lens' ListPipes (Maybe Text)

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

listPipes_nextToken :: Lens' ListPipes (Maybe Text)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

listPipes_sourcePrefix :: Lens' ListPipes (Maybe Text)

The prefix matching the pipe source.

listPipes_targetPrefix :: Lens' ListPipes (Maybe Text)

The prefix matching the pipe target.

listPipesResponse_nextToken :: Lens' ListPipesResponse (Maybe Text)

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

listPipesResponse_pipes :: Lens' ListPipesResponse (Maybe [Pipe])

The pipes returned by the call.

listPipesResponse_httpStatus :: Lens' ListPipesResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text

The ARN of the pipe for which you want to view tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))

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

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

StartPipe

startPipe_name :: Lens' StartPipe Text

The name of the pipe.

startPipeResponse_arn :: Lens' StartPipeResponse (Maybe Text)

The ARN of the pipe.

startPipeResponse_creationTime :: Lens' StartPipeResponse (Maybe UTCTime)

The time the pipe was created.

startPipeResponse_currentState :: Lens' StartPipeResponse (Maybe PipeState)

The state the pipe is in.

startPipeResponse_desiredState :: Lens' StartPipeResponse (Maybe RequestedPipeState)

The state the pipe should be in.

startPipeResponse_lastModifiedTime :: Lens' StartPipeResponse (Maybe UTCTime)

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

startPipeResponse_name :: Lens' StartPipeResponse (Maybe Text)

The name of the pipe.

startPipeResponse_httpStatus :: Lens' StartPipeResponse Int

The response's http status code.

StopPipe

stopPipe_name :: Lens' StopPipe Text

The name of the pipe.

stopPipeResponse_arn :: Lens' StopPipeResponse (Maybe Text)

The ARN of the pipe.

stopPipeResponse_creationTime :: Lens' StopPipeResponse (Maybe UTCTime)

The time the pipe was created.

stopPipeResponse_currentState :: Lens' StopPipeResponse (Maybe PipeState)

The state the pipe is in.

stopPipeResponse_desiredState :: Lens' StopPipeResponse (Maybe RequestedPipeState)

The state the pipe should be in.

stopPipeResponse_lastModifiedTime :: Lens' StopPipeResponse (Maybe UTCTime)

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

stopPipeResponse_name :: Lens' StopPipeResponse (Maybe Text)

The name of the pipe.

stopPipeResponse_httpStatus :: Lens' StopPipeResponse Int

The response's http status code.

TagResource

tagResource_resourceArn :: Lens' TagResource Text

The ARN of the pipe.

tagResource_tags :: Lens' TagResource (HashMap Text Text)

The list of key-value pairs associated with the pipe.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text

The ARN of the pipe.

untagResource_tagKeys :: Lens' UntagResource [Text]

The list of tag keys to remove from the pipe.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdatePipe

updatePipe_description :: Lens' UpdatePipe (Maybe Text)

A description of the pipe.

updatePipe_desiredState :: Lens' UpdatePipe (Maybe RequestedPipeState)

The state the pipe should be in.

updatePipe_enrichment :: Lens' UpdatePipe (Maybe Text)

The ARN of the enrichment resource.

updatePipe_enrichmentParameters :: Lens' UpdatePipe (Maybe PipeEnrichmentParameters)

The parameters required to set up enrichment on your pipe.

updatePipe_sourceParameters :: Lens' UpdatePipe (Maybe UpdatePipeSourceParameters)

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

updatePipe_target :: Lens' UpdatePipe (Maybe Text)

The ARN of the target resource.

updatePipe_targetParameters :: Lens' UpdatePipe (Maybe PipeTargetParameters)

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

updatePipe_name :: Lens' UpdatePipe Text

The name of the pipe.

updatePipe_roleArn :: Lens' UpdatePipe Text

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

updatePipeResponse_arn :: Lens' UpdatePipeResponse (Maybe Text)

The ARN of the pipe.

updatePipeResponse_creationTime :: Lens' UpdatePipeResponse (Maybe UTCTime)

The time the pipe was created.

updatePipeResponse_currentState :: Lens' UpdatePipeResponse (Maybe PipeState)

The state the pipe is in.

updatePipeResponse_desiredState :: Lens' UpdatePipeResponse (Maybe RequestedPipeState)

The state the pipe should be in.

updatePipeResponse_lastModifiedTime :: Lens' UpdatePipeResponse (Maybe UTCTime)

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

updatePipeResponse_name :: Lens' UpdatePipeResponse (Maybe Text)

The name of the pipe.

updatePipeResponse_httpStatus :: Lens' UpdatePipeResponse Int

The response's http status code.

Types

AwsVpcConfiguration

awsVpcConfiguration_assignPublicIp :: Lens' AwsVpcConfiguration (Maybe AssignPublicIp)

Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.

awsVpcConfiguration_securityGroups :: Lens' AwsVpcConfiguration (Maybe [Text])

Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

awsVpcConfiguration_subnets :: Lens' AwsVpcConfiguration [Text]

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

BatchArrayProperties

batchArrayProperties_size :: Lens' BatchArrayProperties (Maybe Natural)

The size of the array, if this is an array batch job.

BatchContainerOverrides

batchContainerOverrides_command :: Lens' BatchContainerOverrides (Maybe [Text])

The command to send to the container that overrides the default command from the Docker image or the task definition.

batchContainerOverrides_environment :: Lens' BatchContainerOverrides (Maybe [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.

batchContainerOverrides_instanceType :: Lens' BatchContainerOverrides (Maybe Text)

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

batchContainerOverrides_resourceRequirements :: Lens' BatchContainerOverrides (Maybe [BatchResourceRequirement])

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

BatchEnvironmentVariable

batchEnvironmentVariable_name :: Lens' BatchEnvironmentVariable (Maybe Text)

The name of the key-value pair. For environment variables, this is the name of the environment variable.

batchEnvironmentVariable_value :: Lens' BatchEnvironmentVariable (Maybe Text)

The value of the key-value pair. For environment variables, this is the value of the environment variable.

BatchJobDependency

batchJobDependency_jobId :: Lens' BatchJobDependency (Maybe Text)

The job ID of the Batch job that's associated with this dependency.

batchJobDependency_type :: Lens' BatchJobDependency (Maybe BatchJobDependencyType)

The type of the job dependency.

BatchResourceRequirement

batchResourceRequirement_type :: Lens' BatchResourceRequirement BatchResourceRequirementType

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

batchResourceRequirement_value :: Lens' BatchResourceRequirement Text

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.

type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, 4, or 8

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type="VCPU"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

BatchRetryStrategy

batchRetryStrategy_attempts :: Lens' BatchRetryStrategy (Maybe Natural)

The number of times to move a job to the RUNNABLE status. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

CapacityProviderStrategyItem

capacityProviderStrategyItem_base :: Lens' CapacityProviderStrategyItem (Maybe Natural)

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

capacityProviderStrategyItem_weight :: Lens' CapacityProviderStrategyItem (Maybe Natural)

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

capacityProviderStrategyItem_capacityProvider :: Lens' CapacityProviderStrategyItem Text

The short name of the capacity provider.

DeadLetterConfig

deadLetterConfig_arn :: Lens' DeadLetterConfig (Maybe Text)

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

EcsContainerOverride

ecsContainerOverride_command :: Lens' EcsContainerOverride (Maybe [Text])

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

ecsContainerOverride_cpu :: Lens' EcsContainerOverride (Maybe Int)

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

ecsContainerOverride_environment :: Lens' EcsContainerOverride (Maybe [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.

ecsContainerOverride_environmentFiles :: Lens' EcsContainerOverride (Maybe [EcsEnvironmentFile])

A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

ecsContainerOverride_memory :: Lens' EcsContainerOverride (Maybe Int)

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

ecsContainerOverride_memoryReservation :: Lens' EcsContainerOverride (Maybe Int)

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

ecsContainerOverride_name :: Lens' EcsContainerOverride (Maybe Text)

The name of the container that receives the override. This parameter is required if any override is specified.

ecsContainerOverride_resourceRequirements :: Lens' EcsContainerOverride (Maybe [EcsResourceRequirement])

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

EcsEnvironmentFile

ecsEnvironmentFile_type :: Lens' EcsEnvironmentFile EcsEnvironmentFileType

The file type to use. The only supported value is s3.

ecsEnvironmentFile_value :: Lens' EcsEnvironmentFile Text

The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file.

EcsEnvironmentVariable

ecsEnvironmentVariable_name :: Lens' EcsEnvironmentVariable (Maybe Text)

The name of the key-value pair. For environment variables, this is the name of the environment variable.

ecsEnvironmentVariable_value :: Lens' EcsEnvironmentVariable (Maybe Text)

The value of the key-value pair. For environment variables, this is the value of the environment variable.

EcsEphemeralStorage

ecsEphemeralStorage_sizeInGiB :: Lens' EcsEphemeralStorage Natural

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

EcsInferenceAcceleratorOverride

ecsInferenceAcceleratorOverride_deviceName :: Lens' EcsInferenceAcceleratorOverride (Maybe Text)

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

ecsInferenceAcceleratorOverride_deviceType :: Lens' EcsInferenceAcceleratorOverride (Maybe Text)

The Elastic Inference accelerator type to use.

EcsResourceRequirement

ecsResourceRequirement_type :: Lens' EcsResourceRequirement EcsResourceRequirementType

The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

ecsResourceRequirement_value :: Lens' EcsResourceRequirement Text

The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on.

If the InferenceAccelerator type is used, the value matches the deviceName for an InferenceAccelerator specified in a task definition.

EcsTaskOverride

ecsTaskOverride_containerOverrides :: Lens' EcsTaskOverride (Maybe [EcsContainerOverride])

One or more container overrides that are sent to a task.

ecsTaskOverride_cpu :: Lens' EcsTaskOverride (Maybe Text)

The cpu override for the task.

ecsTaskOverride_ephemeralStorage :: Lens' EcsTaskOverride (Maybe EcsEphemeralStorage)

The ephemeral storage setting override for the task.

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

• Linux platform version 1.4.0 or later.
• Windows platform version 1.0.0 or later.

ecsTaskOverride_executionRoleArn :: Lens' EcsTaskOverride (Maybe Text)

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.

ecsTaskOverride_inferenceAcceleratorOverrides :: Lens' EcsTaskOverride (Maybe [EcsInferenceAcceleratorOverride])

The Elastic Inference accelerator override for the task.

ecsTaskOverride_memory :: Lens' EcsTaskOverride (Maybe Text)

The memory override for the task.

ecsTaskOverride_taskRoleArn :: Lens' EcsTaskOverride (Maybe Text)

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Role for Tasks in the Amazon Elastic Container Service Developer Guide.

Filter

filter_pattern :: Lens' Filter (Maybe Text)

The event pattern.

FilterCriteria

filterCriteria_filters :: Lens' FilterCriteria (Maybe [Filter])

The event patterns.

MQBrokerAccessCredentials

mQBrokerAccessCredentials_basicAuth :: Lens' MQBrokerAccessCredentials (Maybe Text)

The ARN of the Secrets Manager secret.

MSKAccessCredentials

mSKAccessCredentials_clientCertificateTlsAuth :: Lens' MSKAccessCredentials (Maybe Text)

The ARN of the Secrets Manager secret.

mSKAccessCredentials_saslScram512Auth :: Lens' MSKAccessCredentials (Maybe Text)

The ARN of the Secrets Manager secret.

NetworkConfiguration

networkConfiguration_awsvpcConfiguration :: Lens' NetworkConfiguration (Maybe AwsVpcConfiguration)

Use this structure to specify 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.

Pipe

pipe_arn :: Lens' Pipe (Maybe Text)

The ARN of the pipe.

pipe_creationTime :: Lens' Pipe (Maybe UTCTime)

The time the pipe was created.

pipe_currentState :: Lens' Pipe (Maybe PipeState)

The state the pipe is in.

pipe_desiredState :: Lens' Pipe (Maybe RequestedPipeState)

The state the pipe should be in.

pipe_enrichment :: Lens' Pipe (Maybe Text)

The ARN of the enrichment resource.

pipe_lastModifiedTime :: Lens' Pipe (Maybe UTCTime)

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

pipe_name :: Lens' Pipe (Maybe Text)

The name of the pipe.

pipe_source :: Lens' Pipe (Maybe Text)

The ARN of the source resource.

pipe_stateReason :: Lens' Pipe (Maybe Text)

The reason the pipe is in its current state.

pipe_target :: Lens' Pipe (Maybe Text)

The ARN of the target resource.

PipeEnrichmentHttpParameters

pipeEnrichmentHttpParameters_headerParameters :: Lens' PipeEnrichmentHttpParameters (Maybe (HashMap Text Text))

The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

pipeEnrichmentHttpParameters_pathParameterValues :: Lens' PipeEnrichmentHttpParameters (Maybe [Text])

The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

pipeEnrichmentHttpParameters_queryStringParameters :: Lens' PipeEnrichmentHttpParameters (Maybe (HashMap Text Text))

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

PipeEnrichmentParameters

pipeEnrichmentParameters_httpParameters :: Lens' PipeEnrichmentParameters (Maybe PipeEnrichmentHttpParameters)

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.

If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.

pipeEnrichmentParameters_inputTemplate :: Lens' PipeEnrichmentParameters (Maybe Text)

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.

PipeSourceActiveMQBrokerParameters

pipeSourceActiveMQBrokerParameters_batchSize :: Lens' PipeSourceActiveMQBrokerParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceActiveMQBrokerParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceActiveMQBrokerParameters (Maybe Natural)

The maximum length of a time to wait for events.

pipeSourceActiveMQBrokerParameters_credentials :: Lens' PipeSourceActiveMQBrokerParameters MQBrokerAccessCredentials

The credentials needed to access the resource.

pipeSourceActiveMQBrokerParameters_queueName :: Lens' PipeSourceActiveMQBrokerParameters Text

The name of the destination queue to consume.

PipeSourceDynamoDBStreamParameters

pipeSourceDynamoDBStreamParameters_batchSize :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceDynamoDBStreamParameters_deadLetterConfig :: Lens' PipeSourceDynamoDBStreamParameters (Maybe DeadLetterConfig)

Define the target queue to send dead-letter queue events to.

pipeSourceDynamoDBStreamParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Natural)

The maximum length of a time to wait for events.

pipeSourceDynamoDBStreamParameters_maximumRecordAgeInSeconds :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Int)

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

pipeSourceDynamoDBStreamParameters_maximumRetryAttempts :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Int)

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

pipeSourceDynamoDBStreamParameters_onPartialBatchItemFailure :: Lens' PipeSourceDynamoDBStreamParameters (Maybe OnPartialBatchItemFailureStreams)

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

pipeSourceDynamoDBStreamParameters_parallelizationFactor :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Natural)

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

pipeSourceDynamoDBStreamParameters_startingPosition :: Lens' PipeSourceDynamoDBStreamParameters DynamoDBStreamStartPosition

(Streams only) The position in a stream from which to start reading.

PipeSourceKinesisStreamParameters

pipeSourceKinesisStreamParameters_batchSize :: Lens' PipeSourceKinesisStreamParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceKinesisStreamParameters_deadLetterConfig :: Lens' PipeSourceKinesisStreamParameters (Maybe DeadLetterConfig)

Define the target queue to send dead-letter queue events to.

pipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceKinesisStreamParameters (Maybe Natural)

The maximum length of a time to wait for events.

pipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds :: Lens' PipeSourceKinesisStreamParameters (Maybe Int)

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

pipeSourceKinesisStreamParameters_maximumRetryAttempts :: Lens' PipeSourceKinesisStreamParameters (Maybe Int)

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

pipeSourceKinesisStreamParameters_onPartialBatchItemFailure :: Lens' PipeSourceKinesisStreamParameters (Maybe OnPartialBatchItemFailureStreams)

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

pipeSourceKinesisStreamParameters_parallelizationFactor :: Lens' PipeSourceKinesisStreamParameters (Maybe Natural)

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

pipeSourceKinesisStreamParameters_startingPositionTimestamp :: Lens' PipeSourceKinesisStreamParameters (Maybe UTCTime)

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

pipeSourceKinesisStreamParameters_startingPosition :: Lens' PipeSourceKinesisStreamParameters KinesisStreamStartPosition

(Streams only) The position in a stream from which to start reading.

PipeSourceManagedStreamingKafkaParameters

pipeSourceManagedStreamingKafkaParameters_batchSize :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceManagedStreamingKafkaParameters_consumerGroupID :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Text)

The name of the destination queue to consume.

pipeSourceManagedStreamingKafkaParameters_credentials :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe MSKAccessCredentials)

The credentials needed to access the resource.

pipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Natural)

The maximum length of a time to wait for events.

pipeSourceManagedStreamingKafkaParameters_startingPosition :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe MSKStartPosition)

(Streams only) The position in a stream from which to start reading.

pipeSourceManagedStreamingKafkaParameters_topicName :: Lens' PipeSourceManagedStreamingKafkaParameters Text

The name of the topic that the pipe will read from.

PipeSourceParameters

pipeSourceParameters_activeMQBrokerParameters :: Lens' PipeSourceParameters (Maybe PipeSourceActiveMQBrokerParameters)

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

pipeSourceParameters_dynamoDBStreamParameters :: Lens' PipeSourceParameters (Maybe PipeSourceDynamoDBStreamParameters)

The parameters for using a DynamoDB stream as a source.

pipeSourceParameters_filterCriteria :: Lens' PipeSourceParameters (Maybe FilterCriteria)

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

pipeSourceParameters_kinesisStreamParameters :: Lens' PipeSourceParameters (Maybe PipeSourceKinesisStreamParameters)

The parameters for using a Kinesis stream as a source.

pipeSourceParameters_managedStreamingKafkaParameters :: Lens' PipeSourceParameters (Maybe PipeSourceManagedStreamingKafkaParameters)

The parameters for using an MSK stream as a source.

pipeSourceParameters_rabbitMQBrokerParameters :: Lens' PipeSourceParameters (Maybe PipeSourceRabbitMQBrokerParameters)

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

pipeSourceParameters_selfManagedKafkaParameters :: Lens' PipeSourceParameters (Maybe PipeSourceSelfManagedKafkaParameters)

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

pipeSourceParameters_sqsQueueParameters :: Lens' PipeSourceParameters (Maybe PipeSourceSqsQueueParameters)

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

PipeSourceRabbitMQBrokerParameters

pipeSourceRabbitMQBrokerParameters_batchSize :: Lens' PipeSourceRabbitMQBrokerParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceRabbitMQBrokerParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceRabbitMQBrokerParameters (Maybe Natural)

The maximum length of a time to wait for events.

pipeSourceRabbitMQBrokerParameters_virtualHost :: Lens' PipeSourceRabbitMQBrokerParameters (Maybe Text)

The name of the virtual host associated with the source broker.

pipeSourceRabbitMQBrokerParameters_credentials :: Lens' PipeSourceRabbitMQBrokerParameters MQBrokerAccessCredentials

The credentials needed to access the resource.

pipeSourceRabbitMQBrokerParameters_queueName :: Lens' PipeSourceRabbitMQBrokerParameters Text

The name of the destination queue to consume.

PipeSourceSelfManagedKafkaParameters

pipeSourceSelfManagedKafkaParameters_additionalBootstrapServers :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe [Text])

An array of server URLs.

pipeSourceSelfManagedKafkaParameters_batchSize :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceSelfManagedKafkaParameters_consumerGroupID :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Text)

The name of the destination queue to consume.

pipeSourceSelfManagedKafkaParameters_credentials :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaAccessConfigurationCredentials)

The credentials needed to access the resource.

pipeSourceSelfManagedKafkaParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Natural)

The maximum length of a time to wait for events.

pipeSourceSelfManagedKafkaParameters_serverRootCaCertificate :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe Text)

The ARN of the Secrets Manager secret used for certification.

pipeSourceSelfManagedKafkaParameters_startingPosition :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaStartPosition)

(Streams only) The position in a stream from which to start reading.

pipeSourceSelfManagedKafkaParameters_vpc :: Lens' PipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaAccessConfigurationVpc)

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

pipeSourceSelfManagedKafkaParameters_topicName :: Lens' PipeSourceSelfManagedKafkaParameters Text

The name of the topic that the pipe will read from.

PipeSourceSqsQueueParameters

pipeSourceSqsQueueParameters_batchSize :: Lens' PipeSourceSqsQueueParameters (Maybe Natural)

The maximum number of records to include in each batch.

pipeSourceSqsQueueParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceSqsQueueParameters (Maybe Natural)

The maximum length of a time to wait for events.

PipeTargetBatchJobParameters

pipeTargetBatchJobParameters_arrayProperties :: Lens' PipeTargetBatchJobParameters (Maybe 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.

pipeTargetBatchJobParameters_containerOverrides :: Lens' PipeTargetBatchJobParameters (Maybe BatchContainerOverrides)

The overrides that are sent to a container.

pipeTargetBatchJobParameters_dependsOn :: Lens' PipeTargetBatchJobParameters (Maybe [BatchJobDependency])

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

pipeTargetBatchJobParameters_parameters :: Lens' PipeTargetBatchJobParameters (Maybe (HashMap Text Text))

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

pipeTargetBatchJobParameters_retryStrategy :: Lens' PipeTargetBatchJobParameters (Maybe BatchRetryStrategy)

The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

pipeTargetBatchJobParameters_jobDefinition :: Lens' PipeTargetBatchJobParameters Text

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

pipeTargetBatchJobParameters_jobName :: Lens' PipeTargetBatchJobParameters Text

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

PipeTargetCloudWatchLogsParameters

pipeTargetCloudWatchLogsParameters_logStreamName :: Lens' PipeTargetCloudWatchLogsParameters (Maybe Text)

The name of the log stream.

pipeTargetCloudWatchLogsParameters_timestamp :: Lens' PipeTargetCloudWatchLogsParameters (Maybe Text)

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

PipeTargetEcsTaskParameters

pipeTargetEcsTaskParameters_capacityProviderStrategy :: Lens' PipeTargetEcsTaskParameters (Maybe [CapacityProviderStrategyItem])

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

pipeTargetEcsTaskParameters_enableECSManagedTags :: Lens' PipeTargetEcsTaskParameters (Maybe Bool)

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

pipeTargetEcsTaskParameters_enableExecuteCommand :: Lens' PipeTargetEcsTaskParameters (Maybe Bool)

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

pipeTargetEcsTaskParameters_group :: Lens' PipeTargetEcsTaskParameters (Maybe Text)

Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.

pipeTargetEcsTaskParameters_launchType :: Lens' PipeTargetEcsTaskParameters (Maybe LaunchType)

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

pipeTargetEcsTaskParameters_networkConfiguration :: Lens' PipeTargetEcsTaskParameters (Maybe NetworkConfiguration)

Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

pipeTargetEcsTaskParameters_overrides :: Lens' PipeTargetEcsTaskParameters (Maybe EcsTaskOverride)

The overrides that are associated with a task.

pipeTargetEcsTaskParameters_placementConstraints :: Lens' PipeTargetEcsTaskParameters (Maybe [PlacementConstraint])

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

pipeTargetEcsTaskParameters_placementStrategy :: Lens' PipeTargetEcsTaskParameters (Maybe [PlacementStrategy])

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

pipeTargetEcsTaskParameters_platformVersion :: Lens' PipeTargetEcsTaskParameters (Maybe Text)

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

pipeTargetEcsTaskParameters_propagateTags :: Lens' PipeTargetEcsTaskParameters (Maybe PropagateTags)

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

pipeTargetEcsTaskParameters_referenceId :: Lens' PipeTargetEcsTaskParameters (Maybe Text)

The reference ID to use for the task.

pipeTargetEcsTaskParameters_tags :: Lens' PipeTargetEcsTaskParameters (Maybe [Tag])

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

pipeTargetEcsTaskParameters_taskCount :: Lens' PipeTargetEcsTaskParameters (Maybe Natural)

The number of tasks to create based on TaskDefinition. The default is 1.

pipeTargetEcsTaskParameters_taskDefinitionArn :: Lens' PipeTargetEcsTaskParameters Text

The ARN of the task definition to use if the event target is an Amazon ECS task.

PipeTargetEventBridgeEventBusParameters

pipeTargetEventBridgeEventBusParameters_detailType :: Lens' PipeTargetEventBridgeEventBusParameters (Maybe Text)

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

pipeTargetEventBridgeEventBusParameters_endpointId :: Lens' PipeTargetEventBridgeEventBusParameters (Maybe Text)

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.

pipeTargetEventBridgeEventBusParameters_resources :: Lens' PipeTargetEventBridgeEventBusParameters (Maybe [Text])

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

pipeTargetEventBridgeEventBusParameters_source :: Lens' PipeTargetEventBridgeEventBusParameters (Maybe Text)

The source of the event.

pipeTargetEventBridgeEventBusParameters_time :: Lens' PipeTargetEventBridgeEventBusParameters (Maybe Text)

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

PipeTargetHttpParameters

pipeTargetHttpParameters_headerParameters :: Lens' PipeTargetHttpParameters (Maybe (HashMap Text Text))

The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

pipeTargetHttpParameters_pathParameterValues :: Lens' PipeTargetHttpParameters (Maybe [Text])

The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").

pipeTargetHttpParameters_queryStringParameters :: Lens' PipeTargetHttpParameters (Maybe (HashMap Text Text))

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

PipeTargetKinesisStreamParameters

pipeTargetKinesisStreamParameters_partitionKey :: Lens' PipeTargetKinesisStreamParameters Text

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

PipeTargetLambdaFunctionParameters

pipeTargetLambdaFunctionParameters_invocationType :: Lens' PipeTargetLambdaFunctionParameters (Maybe PipeTargetInvocationType)

Choose from the following options.

• RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.
• Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.
• DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

PipeTargetParameters

pipeTargetParameters_batchJobParameters :: Lens' PipeTargetParameters (Maybe PipeTargetBatchJobParameters)

The parameters for using an Batch job as a target.

pipeTargetParameters_cloudWatchLogsParameters :: Lens' PipeTargetParameters (Maybe PipeTargetCloudWatchLogsParameters)

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

pipeTargetParameters_ecsTaskParameters :: Lens' PipeTargetParameters (Maybe PipeTargetEcsTaskParameters)

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

pipeTargetParameters_eventBridgeEventBusParameters :: Lens' PipeTargetParameters (Maybe PipeTargetEventBridgeEventBusParameters)

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

pipeTargetParameters_httpParameters :: Lens' PipeTargetParameters (Maybe PipeTargetHttpParameters)

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

pipeTargetParameters_inputTemplate :: Lens' PipeTargetParameters (Maybe Text)

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.

pipeTargetParameters_kinesisStreamParameters :: Lens' PipeTargetParameters (Maybe PipeTargetKinesisStreamParameters)

The parameters for using a Kinesis stream as a source.

pipeTargetParameters_lambdaFunctionParameters :: Lens' PipeTargetParameters (Maybe PipeTargetLambdaFunctionParameters)

The parameters for using a Lambda function as a target.

pipeTargetParameters_redshiftDataParameters :: Lens' PipeTargetParameters (Maybe PipeTargetRedshiftDataParameters)

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

pipeTargetParameters_sageMakerPipelineParameters :: Lens' PipeTargetParameters (Maybe PipeTargetSageMakerPipelineParameters)

The parameters for using a SageMaker pipeline as a target.

pipeTargetParameters_sqsQueueParameters :: Lens' PipeTargetParameters (Maybe PipeTargetSqsQueueParameters)

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

pipeTargetParameters_stepFunctionStateMachineParameters :: Lens' PipeTargetParameters (Maybe PipeTargetStateMachineParameters)

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

PipeTargetRedshiftDataParameters

pipeTargetRedshiftDataParameters_dbUser :: Lens' PipeTargetRedshiftDataParameters (Maybe Text)

The database user name. Required when authenticating using temporary credentials.

pipeTargetRedshiftDataParameters_secretManagerArn :: Lens' PipeTargetRedshiftDataParameters (Maybe Text)

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

pipeTargetRedshiftDataParameters_statementName :: Lens' PipeTargetRedshiftDataParameters (Maybe Text)

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

pipeTargetRedshiftDataParameters_withEvent :: Lens' PipeTargetRedshiftDataParameters (Maybe Bool)

Indicates whether to send an event back to EventBridge after the SQL statement runs.

pipeTargetRedshiftDataParameters_database :: Lens' PipeTargetRedshiftDataParameters Text

The name of the database. Required when authenticating using temporary credentials.

pipeTargetRedshiftDataParameters_sqls :: Lens' PipeTargetRedshiftDataParameters (NonEmpty Text)

The SQL statement text to run.

PipeTargetSageMakerPipelineParameters

pipeTargetSageMakerPipelineParameters_pipelineParameterList :: Lens' PipeTargetSageMakerPipelineParameters (Maybe [SageMakerPipelineParameter])

List of Parameter names and values for SageMaker Model Building Pipeline execution.

PipeTargetSqsQueueParameters

pipeTargetSqsQueueParameters_messageDeduplicationId :: Lens' PipeTargetSqsQueueParameters (Maybe Text)

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages.

pipeTargetSqsQueueParameters_messageGroupId :: Lens' PipeTargetSqsQueueParameters (Maybe Text)

The FIFO message group ID to use as the target.

PipeTargetStateMachineParameters

pipeTargetStateMachineParameters_invocationType :: Lens' PipeTargetStateMachineParameters (Maybe PipeTargetInvocationType)

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

PlacementConstraint

placementConstraint_expression :: Lens' PlacementConstraint (Maybe Text)

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

placementConstraint_type :: Lens' PlacementConstraint (Maybe PlacementConstraintType)

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

PlacementStrategy

placementStrategy_field :: Lens' PlacementStrategy (Maybe Text)

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

placementStrategy_type :: Lens' PlacementStrategy (Maybe PlacementStrategyType)

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

SageMakerPipelineParameter

sageMakerPipelineParameter_name :: Lens' SageMakerPipelineParameter Text

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

sageMakerPipelineParameter_value :: Lens' SageMakerPipelineParameter Text

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

SelfManagedKafkaAccessConfigurationCredentials

selfManagedKafkaAccessConfigurationCredentials_basicAuth :: Lens' SelfManagedKafkaAccessConfigurationCredentials (Maybe Text)

The ARN of the Secrets Manager secret.

selfManagedKafkaAccessConfigurationCredentials_clientCertificateTlsAuth :: Lens' SelfManagedKafkaAccessConfigurationCredentials (Maybe Text)

The ARN of the Secrets Manager secret.

selfManagedKafkaAccessConfigurationCredentials_saslScram256Auth :: Lens' SelfManagedKafkaAccessConfigurationCredentials (Maybe Text)

The ARN of the Secrets Manager secret.

selfManagedKafkaAccessConfigurationCredentials_saslScram512Auth :: Lens' SelfManagedKafkaAccessConfigurationCredentials (Maybe Text)

The ARN of the Secrets Manager secret.

SelfManagedKafkaAccessConfigurationVpc

selfManagedKafkaAccessConfigurationVpc_securityGroup :: Lens' SelfManagedKafkaAccessConfigurationVpc (Maybe [Text])

Specifies the security groups associated with the stream. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

selfManagedKafkaAccessConfigurationVpc_subnets :: Lens' SelfManagedKafkaAccessConfigurationVpc (Maybe [Text])

Specifies the subnets associated with the stream. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

Tag

tag_key :: Lens' Tag Text

A string you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

tag_value :: Lens' Tag Text

The value for the specified tag key.

UpdatePipeSourceActiveMQBrokerParameters

updatePipeSourceActiveMQBrokerParameters_batchSize :: Lens' UpdatePipeSourceActiveMQBrokerParameters (Maybe Natural)

The maximum number of records to include in each batch.

updatePipeSourceActiveMQBrokerParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceActiveMQBrokerParameters (Maybe Natural)

The maximum length of a time to wait for events.

updatePipeSourceActiveMQBrokerParameters_credentials :: Lens' UpdatePipeSourceActiveMQBrokerParameters MQBrokerAccessCredentials

The credentials needed to access the resource.

UpdatePipeSourceDynamoDBStreamParameters

updatePipeSourceDynamoDBStreamParameters_batchSize :: Lens' UpdatePipeSourceDynamoDBStreamParameters (Maybe Natural)

The maximum number of records to include in each batch.

updatePipeSourceDynamoDBStreamParameters_deadLetterConfig :: Lens' UpdatePipeSourceDynamoDBStreamParameters (Maybe DeadLetterConfig)

Define the target queue to send dead-letter queue events to.

updatePipeSourceDynamoDBStreamParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceDynamoDBStreamParameters (Maybe Natural)

The maximum length of a time to wait for events.

updatePipeSourceDynamoDBStreamParameters_maximumRecordAgeInSeconds :: Lens' UpdatePipeSourceDynamoDBStreamParameters (Maybe Int)

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

updatePipeSourceDynamoDBStreamParameters_maximumRetryAttempts :: Lens' UpdatePipeSourceDynamoDBStreamParameters (Maybe Int)

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

updatePipeSourceDynamoDBStreamParameters_onPartialBatchItemFailure :: Lens' UpdatePipeSourceDynamoDBStreamParameters (Maybe OnPartialBatchItemFailureStreams)

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

updatePipeSourceDynamoDBStreamParameters_parallelizationFactor :: Lens' UpdatePipeSourceDynamoDBStreamParameters (Maybe Natural)

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

UpdatePipeSourceKinesisStreamParameters

updatePipeSourceKinesisStreamParameters_batchSize :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Natural)

The maximum number of records to include in each batch.

updatePipeSourceKinesisStreamParameters_deadLetterConfig :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe DeadLetterConfig)

Define the target queue to send dead-letter queue events to.

updatePipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Natural)

The maximum length of a time to wait for events.

updatePipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Int)

(Streams only) Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

updatePipeSourceKinesisStreamParameters_maximumRetryAttempts :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Int)

(Streams only) Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

updatePipeSourceKinesisStreamParameters_onPartialBatchItemFailure :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe OnPartialBatchItemFailureStreams)

(Streams only) Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

updatePipeSourceKinesisStreamParameters_parallelizationFactor :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Natural)

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

UpdatePipeSourceManagedStreamingKafkaParameters

updatePipeSourceManagedStreamingKafkaParameters_batchSize :: Lens' UpdatePipeSourceManagedStreamingKafkaParameters (Maybe Natural)

The maximum number of records to include in each batch.

updatePipeSourceManagedStreamingKafkaParameters_credentials :: Lens' UpdatePipeSourceManagedStreamingKafkaParameters (Maybe MSKAccessCredentials)

The credentials needed to access the resource.

updatePipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceManagedStreamingKafkaParameters (Maybe Natural)

The maximum length of a time to wait for events.

UpdatePipeSourceParameters

updatePipeSourceParameters_activeMQBrokerParameters :: Lens' UpdatePipeSourceParameters (Maybe UpdatePipeSourceActiveMQBrokerParameters)

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

updatePipeSourceParameters_dynamoDBStreamParameters :: Lens' UpdatePipeSourceParameters (Maybe UpdatePipeSourceDynamoDBStreamParameters)

The parameters for using a DynamoDB stream as a source.

updatePipeSourceParameters_filterCriteria :: Lens' UpdatePipeSourceParameters (Maybe FilterCriteria)

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

updatePipeSourceParameters_kinesisStreamParameters :: Lens' UpdatePipeSourceParameters (Maybe UpdatePipeSourceKinesisStreamParameters)

The parameters for using a Kinesis stream as a source.

updatePipeSourceParameters_managedStreamingKafkaParameters :: Lens' UpdatePipeSourceParameters (Maybe UpdatePipeSourceManagedStreamingKafkaParameters)

The parameters for using an MSK stream as a source.

updatePipeSourceParameters_rabbitMQBrokerParameters :: Lens' UpdatePipeSourceParameters (Maybe UpdatePipeSourceRabbitMQBrokerParameters)

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

updatePipeSourceParameters_selfManagedKafkaParameters :: Lens' UpdatePipeSourceParameters (Maybe UpdatePipeSourceSelfManagedKafkaParameters)

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

updatePipeSourceParameters_sqsQueueParameters :: Lens' UpdatePipeSourceParameters (Maybe UpdatePipeSourceSqsQueueParameters)

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

UpdatePipeSourceRabbitMQBrokerParameters

updatePipeSourceRabbitMQBrokerParameters_batchSize :: Lens' UpdatePipeSourceRabbitMQBrokerParameters (Maybe Natural)

The maximum number of records to include in each batch.

updatePipeSourceRabbitMQBrokerParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceRabbitMQBrokerParameters (Maybe Natural)

The maximum length of a time to wait for events.

updatePipeSourceRabbitMQBrokerParameters_credentials :: Lens' UpdatePipeSourceRabbitMQBrokerParameters MQBrokerAccessCredentials

The credentials needed to access the resource.

UpdatePipeSourceSelfManagedKafkaParameters

updatePipeSourceSelfManagedKafkaParameters_batchSize :: Lens' UpdatePipeSourceSelfManagedKafkaParameters (Maybe Natural)

The maximum number of records to include in each batch.

updatePipeSourceSelfManagedKafkaParameters_credentials :: Lens' UpdatePipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaAccessConfigurationCredentials)

The credentials needed to access the resource.

updatePipeSourceSelfManagedKafkaParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceSelfManagedKafkaParameters (Maybe Natural)

The maximum length of a time to wait for events.

updatePipeSourceSelfManagedKafkaParameters_serverRootCaCertificate :: Lens' UpdatePipeSourceSelfManagedKafkaParameters (Maybe Text)

The ARN of the Secrets Manager secret used for certification.

updatePipeSourceSelfManagedKafkaParameters_vpc :: Lens' UpdatePipeSourceSelfManagedKafkaParameters (Maybe SelfManagedKafkaAccessConfigurationVpc)

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

UpdatePipeSourceSqsQueueParameters

updatePipeSourceSqsQueueParameters_batchSize :: Lens' UpdatePipeSourceSqsQueueParameters (Maybe Natural)

The maximum number of records to include in each batch.

updatePipeSourceSqsQueueParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceSqsQueueParameters (Maybe Natural)

The maximum length of a time to wait for events.