AWS SDK for PHP 3.x

Service ID: pipes

Version: 2015-10-07

This page describes the parameters and results for the operations of the Amazon EventBridge Pipes (2015-10-07), and shows how to use the Aws\Pipes\PipesClient object to call the described operations. This documentation is specific to the 2015-10-07 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreatePipe ( array $params = [] ): Create a pipe.
DeletePipe ( array $params = [] ): Delete an existing pipe.
DescribePipe ( array $params = [] ): Get the information about an existing pipe.
ListPipes ( array $params = [] ): Get the pipes associated with this account.
ListTagsForResource ( array $params = [] ): Displays the tags associated with a pipe.
StartPipe ( array $params = [] ): Start an existing pipe.
StopPipe ( array $params = [] ): Stop an existing pipe.
TagResource ( array $params = [] ): Assigns one or more tags (key-value pairs) to the specified pipe.
UntagResource ( array $params = [] ): Removes one or more tags from the specified pipes.
UpdatePipe ( array $params = [] ): Update an existing pipe.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListPipes

Operations

CreatePipe

$result = $client->createPipe([/* ... */]);
$promise = $client->createPipeAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createPipe([
    'Description' => '<string>',
    'DesiredState' => 'RUNNING|STOPPED',
    'Enrichment' => '<string>',
    'EnrichmentParameters' => [
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'InputTemplate' => '<string>',
    ],
    'LogConfiguration' => [
        'CloudwatchLogsLogDestination' => [
            'LogGroupArn' => '<string>', // REQUIRED
        ],
        'FirehoseLogDestination' => [
            'DeliveryStreamArn' => '<string>', // REQUIRED
        ],
        'IncludeExecutionData' => ['<string>', ...],
        'Level' => 'OFF|ERROR|INFO|TRACE', // REQUIRED
        'S3LogDestination' => [
            'BucketName' => '<string>', // REQUIRED
            'BucketOwner' => '<string>', // REQUIRED
            'OutputFormat' => 'json|plain|w3c',
            'Prefix' => '<string>',
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'Source' => '<string>', // REQUIRED
    'SourceParameters' => [
        'ActiveMQBrokerParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [ // REQUIRED
                'BasicAuth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'QueueName' => '<string>', // REQUIRED
        ],
        'DynamoDBStreamParameters' => [
            'BatchSize' => <integer>,
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'MaximumRecordAgeInSeconds' => <integer>,
            'MaximumRetryAttempts' => <integer>,
            'OnPartialBatchItemFailure' => 'AUTOMATIC_BISECT',
            'ParallelizationFactor' => <integer>,
            'StartingPosition' => 'TRIM_HORIZON|LATEST', // REQUIRED
        ],
        'FilterCriteria' => [
            'Filters' => [
                [
                    'Pattern' => '<string>',
                ],
                // ...
            ],
        ],
        'KinesisStreamParameters' => [
            'BatchSize' => <integer>,
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'MaximumRecordAgeInSeconds' => <integer>,
            'MaximumRetryAttempts' => <integer>,
            'OnPartialBatchItemFailure' => 'AUTOMATIC_BISECT',
            'ParallelizationFactor' => <integer>,
            'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP', // REQUIRED
            'StartingPositionTimestamp' => <integer || string || DateTime>,
        ],
        'ManagedStreamingKafkaParameters' => [
            'BatchSize' => <integer>,
            'ConsumerGroupID' => '<string>',
            'Credentials' => [
                'ClientCertificateTlsAuth' => '<string>',
                'SaslScram512Auth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'StartingPosition' => 'TRIM_HORIZON|LATEST',
            'TopicName' => '<string>', // REQUIRED
        ],
        'RabbitMQBrokerParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [ // REQUIRED
                'BasicAuth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'QueueName' => '<string>', // REQUIRED
            'VirtualHost' => '<string>',
        ],
        'SelfManagedKafkaParameters' => [
            'AdditionalBootstrapServers' => ['<string>', ...],
            'BatchSize' => <integer>,
            'ConsumerGroupID' => '<string>',
            'Credentials' => [
                'BasicAuth' => '<string>',
                'ClientCertificateTlsAuth' => '<string>',
                'SaslScram256Auth' => '<string>',
                'SaslScram512Auth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'ServerRootCaCertificate' => '<string>',
            'StartingPosition' => 'TRIM_HORIZON|LATEST',
            'TopicName' => '<string>', // REQUIRED
            'Vpc' => [
                'SecurityGroup' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        'SqsQueueParameters' => [
            'BatchSize' => <integer>,
            'MaximumBatchingWindowInSeconds' => <integer>,
        ],
    ],
    'Tags' => ['<string>', ...],
    'Target' => '<string>', // REQUIRED
    'TargetParameters' => [
        'BatchJobParameters' => [
            'ArrayProperties' => [
                'Size' => <integer>,
            ],
            'ContainerOverrides' => [
                'Command' => ['<string>', ...],
                'Environment' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'InstanceType' => '<string>',
                'ResourceRequirements' => [
                    [
                        'Type' => 'GPU|MEMORY|VCPU', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'DependsOn' => [
                [
                    'JobId' => '<string>',
                    'Type' => 'N_TO_N|SEQUENTIAL',
                ],
                // ...
            ],
            'JobDefinition' => '<string>', // REQUIRED
            'JobName' => '<string>', // REQUIRED
            'Parameters' => ['<string>', ...],
            'RetryStrategy' => [
                'Attempts' => <integer>,
            ],
        ],
        'CloudWatchLogsParameters' => [
            'LogStreamName' => '<string>',
            'Timestamp' => '<string>',
        ],
        'EcsTaskParameters' => [
            'CapacityProviderStrategy' => [
                [
                    'base' => <integer>,
                    'capacityProvider' => '<string>', // REQUIRED
                    'weight' => <integer>,
                ],
                // ...
            ],
            'EnableECSManagedTags' => true || false,
            'EnableExecuteCommand' => true || false,
            'Group' => '<string>',
            'LaunchType' => 'EC2|FARGATE|EXTERNAL',
            'NetworkConfiguration' => [
                'awsvpcConfiguration' => [
                    'AssignPublicIp' => 'ENABLED|DISABLED',
                    'SecurityGroups' => ['<string>', ...],
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'Overrides' => [
                'ContainerOverrides' => [
                    [
                        'Command' => ['<string>', ...],
                        'Cpu' => <integer>,
                        'Environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'EnvironmentFiles' => [
                            [
                                'type' => 's3', // REQUIRED
                                'value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Memory' => <integer>,
                        'MemoryReservation' => <integer>,
                        'Name' => '<string>',
                        'ResourceRequirements' => [
                            [
                                'type' => 'GPU|InferenceAccelerator', // REQUIRED
                                'value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'Cpu' => '<string>',
                'EphemeralStorage' => [
                    'sizeInGiB' => <integer>, // REQUIRED
                ],
                'ExecutionRoleArn' => '<string>',
                'InferenceAcceleratorOverrides' => [
                    [
                        'deviceName' => '<string>',
                        'deviceType' => '<string>',
                    ],
                    // ...
                ],
                'Memory' => '<string>',
                'TaskRoleArn' => '<string>',
            ],
            'PlacementConstraints' => [
                [
                    'expression' => '<string>',
                    'type' => 'distinctInstance|memberOf',
                ],
                // ...
            ],
            'PlacementStrategy' => [
                [
                    'field' => '<string>',
                    'type' => 'random|spread|binpack',
                ],
                // ...
            ],
            'PlatformVersion' => '<string>',
            'PropagateTags' => 'TASK_DEFINITION',
            'ReferenceId' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'TaskCount' => <integer>,
            'TaskDefinitionArn' => '<string>', // REQUIRED
        ],
        'EventBridgeEventBusParameters' => [
            'DetailType' => '<string>',
            'EndpointId' => '<string>',
            'Resources' => ['<string>', ...],
            'Source' => '<string>',
            'Time' => '<string>',
        ],
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'InputTemplate' => '<string>',
        'KinesisStreamParameters' => [
            'PartitionKey' => '<string>', // REQUIRED
        ],
        'LambdaFunctionParameters' => [
            'InvocationType' => 'REQUEST_RESPONSE|FIRE_AND_FORGET',
        ],
        'RedshiftDataParameters' => [
            'Database' => '<string>', // REQUIRED
            'DbUser' => '<string>',
            'SecretManagerArn' => '<string>',
            'Sqls' => ['<string>', ...], // REQUIRED
            'StatementName' => '<string>',
            'WithEvent' => true || false,
        ],
        'SageMakerPipelineParameters' => [
            'PipelineParameterList' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'SqsQueueParameters' => [
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
        ],
        'StepFunctionStateMachineParameters' => [
            'InvocationType' => 'REQUEST_RESPONSE|FIRE_AND_FORGET',
        ],
    ],
]);

Parameter Details

Members

Description

Type: string

A description of the pipe.

DesiredState

Type: string

The state the pipe should be in.

Enrichment

Type: string

The ARN of the enrichment resource.

EnrichmentParameters

Type: PipeEnrichmentParameters structure

The parameters required to set up enrichment on your pipe.

LogConfiguration

Type: PipeLogConfigurationParameters structure

The logging configuration settings for the pipe.

Name

Required: Yes
Type: string

The name of the pipe.

RoleArn

Required: Yes
Type: string

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

Source

Required: Yes
Type: string

The ARN of the source resource.

SourceParameters

Type: PipeSourceParameters structure

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

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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

Target

Required: Yes
Type: string

The ARN of the target resource.

TargetParameters

Type: PipeTargetParameters structure

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.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
    'DesiredState' => 'RUNNING|STOPPED',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN of the pipe.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the pipe was created.

CurrentState

Type: string

The state the pipe is in.

DesiredState

Type: string

The state the pipe should be in.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

The name of the pipe.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
ThrottlingException:
An action was throttled.
NotFoundException:
An entity that you specified does not exist.
ConflictException:
An action you attempted resulted in an exception.
ServiceQuotaExceededException:
A quota has been exceeded.

DeletePipe

$result = $client->deletePipe([/* ... */]);
$promise = $client->deletePipeAsync([/* ... */]);

Delete an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Parameter Syntax

$result = $client->deletePipe([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the pipe.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
    'DesiredState' => 'RUNNING|STOPPED|DELETED',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN of the pipe.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the pipe was created.

CurrentState

Type: string

The state the pipe is in.

DesiredState

Type: string

The state the pipe should be in.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

The name of the pipe.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
ThrottlingException:
An action was throttled.
NotFoundException:
An entity that you specified does not exist.
ConflictException:
An action you attempted resulted in an exception.

DescribePipe

$result = $client->describePipe([/* ... */]);
$promise = $client->describePipeAsync([/* ... */]);

Get the information about an existing pipe. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Parameter Syntax

$result = $client->describePipe([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the pipe.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
    'Description' => '<string>',
    'DesiredState' => 'RUNNING|STOPPED|DELETED',
    'Enrichment' => '<string>',
    'EnrichmentParameters' => [
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'InputTemplate' => '<string>',
    ],
    'LastModifiedTime' => <DateTime>,
    'LogConfiguration' => [
        'CloudwatchLogsLogDestination' => [
            'LogGroupArn' => '<string>',
        ],
        'FirehoseLogDestination' => [
            'DeliveryStreamArn' => '<string>',
        ],
        'IncludeExecutionData' => ['<string>', ...],
        'Level' => 'OFF|ERROR|INFO|TRACE',
        'S3LogDestination' => [
            'BucketName' => '<string>',
            'BucketOwner' => '<string>',
            'OutputFormat' => 'json|plain|w3c',
            'Prefix' => '<string>',
        ],
    ],
    'Name' => '<string>',
    'RoleArn' => '<string>',
    'Source' => '<string>',
    'SourceParameters' => [
        'ActiveMQBrokerParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [
                'BasicAuth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'QueueName' => '<string>',
        ],
        'DynamoDBStreamParameters' => [
            'BatchSize' => <integer>,
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'MaximumRecordAgeInSeconds' => <integer>,
            'MaximumRetryAttempts' => <integer>,
            'OnPartialBatchItemFailure' => 'AUTOMATIC_BISECT',
            'ParallelizationFactor' => <integer>,
            'StartingPosition' => 'TRIM_HORIZON|LATEST',
        ],
        'FilterCriteria' => [
            'Filters' => [
                [
                    'Pattern' => '<string>',
                ],
                // ...
            ],
        ],
        'KinesisStreamParameters' => [
            'BatchSize' => <integer>,
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'MaximumRecordAgeInSeconds' => <integer>,
            'MaximumRetryAttempts' => <integer>,
            'OnPartialBatchItemFailure' => 'AUTOMATIC_BISECT',
            'ParallelizationFactor' => <integer>,
            'StartingPosition' => 'TRIM_HORIZON|LATEST|AT_TIMESTAMP',
            'StartingPositionTimestamp' => <DateTime>,
        ],
        'ManagedStreamingKafkaParameters' => [
            'BatchSize' => <integer>,
            'ConsumerGroupID' => '<string>',
            'Credentials' => [
                'ClientCertificateTlsAuth' => '<string>',
                'SaslScram512Auth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'StartingPosition' => 'TRIM_HORIZON|LATEST',
            'TopicName' => '<string>',
        ],
        'RabbitMQBrokerParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [
                'BasicAuth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'QueueName' => '<string>',
            'VirtualHost' => '<string>',
        ],
        'SelfManagedKafkaParameters' => [
            'AdditionalBootstrapServers' => ['<string>', ...],
            'BatchSize' => <integer>,
            'ConsumerGroupID' => '<string>',
            'Credentials' => [
                'BasicAuth' => '<string>',
                'ClientCertificateTlsAuth' => '<string>',
                'SaslScram256Auth' => '<string>',
                'SaslScram512Auth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'ServerRootCaCertificate' => '<string>',
            'StartingPosition' => 'TRIM_HORIZON|LATEST',
            'TopicName' => '<string>',
            'Vpc' => [
                'SecurityGroup' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        'SqsQueueParameters' => [
            'BatchSize' => <integer>,
            'MaximumBatchingWindowInSeconds' => <integer>,
        ],
    ],
    'StateReason' => '<string>',
    'Tags' => ['<string>', ...],
    'Target' => '<string>',
    'TargetParameters' => [
        'BatchJobParameters' => [
            'ArrayProperties' => [
                'Size' => <integer>,
            ],
            'ContainerOverrides' => [
                'Command' => ['<string>', ...],
                'Environment' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'InstanceType' => '<string>',
                'ResourceRequirements' => [
                    [
                        'Type' => 'GPU|MEMORY|VCPU',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DependsOn' => [
                [
                    'JobId' => '<string>',
                    'Type' => 'N_TO_N|SEQUENTIAL',
                ],
                // ...
            ],
            'JobDefinition' => '<string>',
            'JobName' => '<string>',
            'Parameters' => ['<string>', ...],
            'RetryStrategy' => [
                'Attempts' => <integer>,
            ],
        ],
        'CloudWatchLogsParameters' => [
            'LogStreamName' => '<string>',
            'Timestamp' => '<string>',
        ],
        'EcsTaskParameters' => [
            'CapacityProviderStrategy' => [
                [
                    'base' => <integer>,
                    'capacityProvider' => '<string>',
                    'weight' => <integer>,
                ],
                // ...
            ],
            'EnableECSManagedTags' => true || false,
            'EnableExecuteCommand' => true || false,
            'Group' => '<string>',
            'LaunchType' => 'EC2|FARGATE|EXTERNAL',
            'NetworkConfiguration' => [
                'awsvpcConfiguration' => [
                    'AssignPublicIp' => 'ENABLED|DISABLED',
                    'SecurityGroups' => ['<string>', ...],
                    'Subnets' => ['<string>', ...],
                ],
            ],
            'Overrides' => [
                'ContainerOverrides' => [
                    [
                        'Command' => ['<string>', ...],
                        'Cpu' => <integer>,
                        'Environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'EnvironmentFiles' => [
                            [
                                'type' => 's3',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'Memory' => <integer>,
                        'MemoryReservation' => <integer>,
                        'Name' => '<string>',
                        'ResourceRequirements' => [
                            [
                                'type' => 'GPU|InferenceAccelerator',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'Cpu' => '<string>',
                'EphemeralStorage' => [
                    'sizeInGiB' => <integer>,
                ],
                'ExecutionRoleArn' => '<string>',
                'InferenceAcceleratorOverrides' => [
                    [
                        'deviceName' => '<string>',
                        'deviceType' => '<string>',
                    ],
                    // ...
                ],
                'Memory' => '<string>',
                'TaskRoleArn' => '<string>',
            ],
            'PlacementConstraints' => [
                [
                    'expression' => '<string>',
                    'type' => 'distinctInstance|memberOf',
                ],
                // ...
            ],
            'PlacementStrategy' => [
                [
                    'field' => '<string>',
                    'type' => 'random|spread|binpack',
                ],
                // ...
            ],
            'PlatformVersion' => '<string>',
            'PropagateTags' => 'TASK_DEFINITION',
            'ReferenceId' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TaskCount' => <integer>,
            'TaskDefinitionArn' => '<string>',
        ],
        'EventBridgeEventBusParameters' => [
            'DetailType' => '<string>',
            'EndpointId' => '<string>',
            'Resources' => ['<string>', ...],
            'Source' => '<string>',
            'Time' => '<string>',
        ],
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'InputTemplate' => '<string>',
        'KinesisStreamParameters' => [
            'PartitionKey' => '<string>',
        ],
        'LambdaFunctionParameters' => [
            'InvocationType' => 'REQUEST_RESPONSE|FIRE_AND_FORGET',
        ],
        'RedshiftDataParameters' => [
            'Database' => '<string>',
            'DbUser' => '<string>',
            'SecretManagerArn' => '<string>',
            'Sqls' => ['<string>', ...],
            'StatementName' => '<string>',
            'WithEvent' => true || false,
        ],
        'SageMakerPipelineParameters' => [
            'PipelineParameterList' => [
                [
                    'Name' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        'SqsQueueParameters' => [
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
        ],
        'StepFunctionStateMachineParameters' => [
            'InvocationType' => 'REQUEST_RESPONSE|FIRE_AND_FORGET',
        ],
    ],
]

Result Details

Members

Arn

Type: string

The ARN of the pipe.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the pipe was created.

CurrentState

Type: string

The state the pipe is in.

Description

Type: string

A description of the pipe.

DesiredState

Type: string

The state the pipe should be in.

Enrichment

Type: string

The ARN of the enrichment resource.

EnrichmentParameters

Type: PipeEnrichmentParameters structure

The parameters required to set up enrichment on your pipe.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

LogConfiguration

Type: PipeLogConfiguration structure

The logging configuration settings for the pipe.

Name

Type: string

The name of the pipe.

RoleArn

Type: string

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

Source

Type: string

The ARN of the source resource.

SourceParameters

Type: PipeSourceParameters structure

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

StateReason

Type: string

The reason the pipe is in its current state.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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

Target

Type: string

The ARN of the target resource.

TargetParameters

Type: PipeTargetParameters structure

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.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
ThrottlingException:
An action was throttled.
NotFoundException:
An entity that you specified does not exist.

ListPipes

$result = $client->listPipes([/* ... */]);
$promise = $client->listPipesAsync([/* ... */]);

Get the pipes associated with this account. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.

Parameter Syntax

$result = $client->listPipes([
    'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
    'DesiredState' => 'RUNNING|STOPPED',
    'Limit' => <integer>,
    'NamePrefix' => '<string>',
    'NextToken' => '<string>',
    'SourcePrefix' => '<string>',
    'TargetPrefix' => '<string>',
]);

Parameter Details

Members

CurrentState

Type: string

The state the pipe is in.

DesiredState

Type: string

The state the pipe should be in.

Limit

Type: int

The maximum number of pipes to include in the response.

NamePrefix

Type: string

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.

NextToken

Type: string

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.

SourcePrefix

Type: string

The prefix matching the pipe source.

TargetPrefix

Type: string

The prefix matching the pipe target.

Result Syntax

[
    'NextToken' => '<string>',
    'Pipes' => [
        [
            'Arn' => '<string>',
            'CreationTime' => <DateTime>,
            'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
            'DesiredState' => 'RUNNING|STOPPED',
            'Enrichment' => '<string>',
            'LastModifiedTime' => <DateTime>,
            'Name' => '<string>',
            'Source' => '<string>',
            'StateReason' => '<string>',
            'Target' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Pipes

Type: Array of Pipe structures

The pipes returned by the call.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
ThrottlingException:
An action was throttled.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Displays the tags associated with a pipe.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

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

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members

tags

Type: Associative array of custom strings keys (TagKey) to strings

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

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
NotFoundException:
An entity that you specified does not exist.

StartPipe

$result = $client->startPipe([/* ... */]);
$promise = $client->startPipeAsync([/* ... */]);

Start an existing pipe.

Parameter Syntax

$result = $client->startPipe([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the pipe.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
    'DesiredState' => 'RUNNING|STOPPED',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN of the pipe.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the pipe was created.

CurrentState

Type: string

The state the pipe is in.

DesiredState

Type: string

The state the pipe should be in.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

The name of the pipe.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
ThrottlingException:
An action was throttled.
NotFoundException:
An entity that you specified does not exist.
ConflictException:
An action you attempted resulted in an exception.

StopPipe

$result = $client->stopPipe([/* ... */]);
$promise = $client->stopPipeAsync([/* ... */]);

Stop an existing pipe.

Parameter Syntax

$result = $client->stopPipe([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Required: Yes
Type: string

The name of the pipe.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
    'DesiredState' => 'RUNNING|STOPPED',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN of the pipe.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the pipe was created.

CurrentState

Type: string

The state the pipe is in.

DesiredState

Type: string

The state the pipe should be in.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

The name of the pipe.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
ThrottlingException:
An action was throttled.
NotFoundException:
An entity that you specified does not exist.
ConflictException:
An action you attempted resulted in an exception.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the pipe.

tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
NotFoundException:
An entity that you specified does not exist.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified pipes.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

resourceArn

Required: Yes
Type: string

The ARN of the pipe.

tagKeys

Required: Yes
Type: Array of strings

The list of tag keys to remove from the pipe.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
NotFoundException:
An entity that you specified does not exist.

UpdatePipe

$result = $client->updatePipe([/* ... */]);
$promise = $client->updatePipeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updatePipe([
    'Description' => '<string>',
    'DesiredState' => 'RUNNING|STOPPED',
    'Enrichment' => '<string>',
    'EnrichmentParameters' => [
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'InputTemplate' => '<string>',
    ],
    'LogConfiguration' => [
        'CloudwatchLogsLogDestination' => [
            'LogGroupArn' => '<string>', // REQUIRED
        ],
        'FirehoseLogDestination' => [
            'DeliveryStreamArn' => '<string>', // REQUIRED
        ],
        'IncludeExecutionData' => ['<string>', ...],
        'Level' => 'OFF|ERROR|INFO|TRACE', // REQUIRED
        'S3LogDestination' => [
            'BucketName' => '<string>', // REQUIRED
            'BucketOwner' => '<string>', // REQUIRED
            'OutputFormat' => 'json|plain|w3c',
            'Prefix' => '<string>',
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'SourceParameters' => [
        'ActiveMQBrokerParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [ // REQUIRED
                'BasicAuth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
        ],
        'DynamoDBStreamParameters' => [
            'BatchSize' => <integer>,
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'MaximumRecordAgeInSeconds' => <integer>,
            'MaximumRetryAttempts' => <integer>,
            'OnPartialBatchItemFailure' => 'AUTOMATIC_BISECT',
            'ParallelizationFactor' => <integer>,
        ],
        'FilterCriteria' => [
            'Filters' => [
                [
                    'Pattern' => '<string>',
                ],
                // ...
            ],
        ],
        'KinesisStreamParameters' => [
            'BatchSize' => <integer>,
            'DeadLetterConfig' => [
                'Arn' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'MaximumRecordAgeInSeconds' => <integer>,
            'MaximumRetryAttempts' => <integer>,
            'OnPartialBatchItemFailure' => 'AUTOMATIC_BISECT',
            'ParallelizationFactor' => <integer>,
        ],
        'ManagedStreamingKafkaParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [
                'ClientCertificateTlsAuth' => '<string>',
                'SaslScram512Auth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
        ],
        'RabbitMQBrokerParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [ // REQUIRED
                'BasicAuth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
        ],
        'SelfManagedKafkaParameters' => [
            'BatchSize' => <integer>,
            'Credentials' => [
                'BasicAuth' => '<string>',
                'ClientCertificateTlsAuth' => '<string>',
                'SaslScram256Auth' => '<string>',
                'SaslScram512Auth' => '<string>',
            ],
            'MaximumBatchingWindowInSeconds' => <integer>,
            'ServerRootCaCertificate' => '<string>',
            'Vpc' => [
                'SecurityGroup' => ['<string>', ...],
                'Subnets' => ['<string>', ...],
            ],
        ],
        'SqsQueueParameters' => [
            'BatchSize' => <integer>,
            'MaximumBatchingWindowInSeconds' => <integer>,
        ],
    ],
    'Target' => '<string>',
    'TargetParameters' => [
        'BatchJobParameters' => [
            'ArrayProperties' => [
                'Size' => <integer>,
            ],
            'ContainerOverrides' => [
                'Command' => ['<string>', ...],
                'Environment' => [
                    [
                        'Name' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
                'InstanceType' => '<string>',
                'ResourceRequirements' => [
                    [
                        'Type' => 'GPU|MEMORY|VCPU', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'DependsOn' => [
                [
                    'JobId' => '<string>',
                    'Type' => 'N_TO_N|SEQUENTIAL',
                ],
                // ...
            ],
            'JobDefinition' => '<string>', // REQUIRED
            'JobName' => '<string>', // REQUIRED
            'Parameters' => ['<string>', ...],
            'RetryStrategy' => [
                'Attempts' => <integer>,
            ],
        ],
        'CloudWatchLogsParameters' => [
            'LogStreamName' => '<string>',
            'Timestamp' => '<string>',
        ],
        'EcsTaskParameters' => [
            'CapacityProviderStrategy' => [
                [
                    'base' => <integer>,
                    'capacityProvider' => '<string>', // REQUIRED
                    'weight' => <integer>,
                ],
                // ...
            ],
            'EnableECSManagedTags' => true || false,
            'EnableExecuteCommand' => true || false,
            'Group' => '<string>',
            'LaunchType' => 'EC2|FARGATE|EXTERNAL',
            'NetworkConfiguration' => [
                'awsvpcConfiguration' => [
                    'AssignPublicIp' => 'ENABLED|DISABLED',
                    'SecurityGroups' => ['<string>', ...],
                    'Subnets' => ['<string>', ...], // REQUIRED
                ],
            ],
            'Overrides' => [
                'ContainerOverrides' => [
                    [
                        'Command' => ['<string>', ...],
                        'Cpu' => <integer>,
                        'Environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'EnvironmentFiles' => [
                            [
                                'type' => 's3', // REQUIRED
                                'value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'Memory' => <integer>,
                        'MemoryReservation' => <integer>,
                        'Name' => '<string>',
                        'ResourceRequirements' => [
                            [
                                'type' => 'GPU|InferenceAccelerator', // REQUIRED
                                'value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
                'Cpu' => '<string>',
                'EphemeralStorage' => [
                    'sizeInGiB' => <integer>, // REQUIRED
                ],
                'ExecutionRoleArn' => '<string>',
                'InferenceAcceleratorOverrides' => [
                    [
                        'deviceName' => '<string>',
                        'deviceType' => '<string>',
                    ],
                    // ...
                ],
                'Memory' => '<string>',
                'TaskRoleArn' => '<string>',
            ],
            'PlacementConstraints' => [
                [
                    'expression' => '<string>',
                    'type' => 'distinctInstance|memberOf',
                ],
                // ...
            ],
            'PlacementStrategy' => [
                [
                    'field' => '<string>',
                    'type' => 'random|spread|binpack',
                ],
                // ...
            ],
            'PlatformVersion' => '<string>',
            'PropagateTags' => 'TASK_DEFINITION',
            'ReferenceId' => '<string>',
            'Tags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'TaskCount' => <integer>,
            'TaskDefinitionArn' => '<string>', // REQUIRED
        ],
        'EventBridgeEventBusParameters' => [
            'DetailType' => '<string>',
            'EndpointId' => '<string>',
            'Resources' => ['<string>', ...],
            'Source' => '<string>',
            'Time' => '<string>',
        ],
        'HttpParameters' => [
            'HeaderParameters' => ['<string>', ...],
            'PathParameterValues' => ['<string>', ...],
            'QueryStringParameters' => ['<string>', ...],
        ],
        'InputTemplate' => '<string>',
        'KinesisStreamParameters' => [
            'PartitionKey' => '<string>', // REQUIRED
        ],
        'LambdaFunctionParameters' => [
            'InvocationType' => 'REQUEST_RESPONSE|FIRE_AND_FORGET',
        ],
        'RedshiftDataParameters' => [
            'Database' => '<string>', // REQUIRED
            'DbUser' => '<string>',
            'SecretManagerArn' => '<string>',
            'Sqls' => ['<string>', ...], // REQUIRED
            'StatementName' => '<string>',
            'WithEvent' => true || false,
        ],
        'SageMakerPipelineParameters' => [
            'PipelineParameterList' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'SqsQueueParameters' => [
            'MessageDeduplicationId' => '<string>',
            'MessageGroupId' => '<string>',
        ],
        'StepFunctionStateMachineParameters' => [
            'InvocationType' => 'REQUEST_RESPONSE|FIRE_AND_FORGET',
        ],
    ],
]);

Parameter Details

Members

Description

Type: string

A description of the pipe.

DesiredState

Type: string

The state the pipe should be in.

Enrichment

Type: string

The ARN of the enrichment resource.

EnrichmentParameters

Type: PipeEnrichmentParameters structure

The parameters required to set up enrichment on your pipe.

LogConfiguration

Type: PipeLogConfigurationParameters structure

The logging configuration settings for the pipe.

Name

Required: Yes
Type: string

The name of the pipe.

RoleArn

Required: Yes
Type: string

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

SourceParameters

Type: UpdatePipeSourceParameters structure

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

Target

Type: string

The ARN of the target resource.

TargetParameters

Type: PipeTargetParameters structure

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.

Result Syntax

[
    'Arn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentState' => 'RUNNING|STOPPED|CREATING|UPDATING|DELETING|STARTING|STOPPING|CREATE_FAILED|UPDATE_FAILED|START_FAILED|STOP_FAILED|DELETE_FAILED|CREATE_ROLLBACK_FAILED|DELETE_ROLLBACK_FAILED|UPDATE_ROLLBACK_FAILED',
    'DesiredState' => 'RUNNING|STOPPED',
    'LastModifiedTime' => <DateTime>,
    'Name' => '<string>',
]

Result Details

Members

Arn

Type: string

The ARN of the pipe.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the pipe was created.

CurrentState

Type: string

The state the pipe is in.

DesiredState

Type: string

The state the pipe should be in.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

The name of the pipe.

Errors

InternalException:
This exception occurs due to unexpected causes.
ValidationException:
Indicates that an error has occurred while performing a validate operation.
ThrottlingException:
An action was throttled.
NotFoundException:
An entity that you specified does not exist.
ConflictException:
An action you attempted resulted in an exception.

Shapes

AwsVpcConfiguration

Description

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.

Members

AssignPublicIp

Type: string

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.

SecurityGroups

Type: Array of strings

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.

Subnets

Required: Yes
Type: Array of strings

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

Description

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.

Members

Size

Type: int

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

BatchContainerOverrides

Description

The overrides that are sent to a container.

Members

Command

Type: Array of strings

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

Environment

Type: Array of BatchEnvironmentVariable structures

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.

InstanceType

Type: string

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.

ResourceRequirements

Type: Array of BatchResourceRequirement structures

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

Description

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

Members

Name

Type: string

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

Value

Type: string

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

BatchJobDependency

Description

An object that represents an Batch job dependency.

Members

JobId

Type: string

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

Type

Type: string

The type of the job dependency.

BatchResourceRequirement

Description

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

Members

Type

Required: Yes
Type: string

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

Value

Required: Yes
Type: string

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

Description

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

Members

Attempts

Type: int

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

Description

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

Members

base

Type: int

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.

capacityProvider

Required: Yes
Type: string

The short name of the capacity provider.

weight

Type: int

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.

CloudwatchLogsLogDestination

Description

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Members

LogGroupArn

Type: string

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

CloudwatchLogsLogDestinationParameters

Description

The Amazon CloudWatch Logs logging configuration settings for the pipe.

Members

LogGroupArn

Required: Yes
Type: string

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

ConflictException

Description

An action you attempted resulted in an exception.

Members

message

Required: Yes
Type: string

resourceId

Required: Yes
Type: string

The ID of the resource that caused the exception.

resourceType

Required: Yes
Type: string

The type of resource that caused the exception.

DeadLetterConfig

Description

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

Members

Arn

Type: string

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.

EcsContainerOverride

Description

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.

Members

Command

Type: Array of strings

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.

Cpu

Type: 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.

Environment

Type: Array of EcsEnvironmentVariable structures

EnvironmentFiles

Type: Array of EcsEnvironmentFile structures

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

Memory

Type: 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.

MemoryReservation

Type: 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.

Name

Type: string

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

ResourceRequirements

Type: Array of EcsResourceRequirement structures

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

Description

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.

Members

type

Required: Yes
Type: string

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

value

Required: Yes
Type: string

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

EcsEnvironmentVariable

Description

Members

name

Type: string

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

value

Type: string

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

EcsEphemeralStorage

Description

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.

Members

sizeInGiB

Required: Yes
Type: int

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

Description

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.

Members

deviceName

Type: string

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

deviceType

Type: string

The Elastic Inference accelerator type to use.

EcsResourceRequirement

Description

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

Members

type

Required: Yes
Type: string

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

value

Required: Yes
Type: string

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

Description

The overrides that are associated with a task.

Members

ContainerOverrides

Type: Array of EcsContainerOverride structures

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

Cpu

Type: string

The cpu override for the task.

EphemeralStorage

Type: EcsEphemeralStorage structure

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.

ExecutionRoleArn

Type: string

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.

InferenceAcceleratorOverrides

Type: Array of EcsInferenceAcceleratorOverride structures

The Elastic Inference accelerator override for the task.

Memory

Type: string

The memory override for the task.

TaskRoleArn

Type: string

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

Description

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

Members

Pattern

Type: string

The event pattern.

FilterCriteria

Description

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.

Members

Filters

Type: Array of Filter structures

The event patterns.

FirehoseLogDestination

Description

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

Members

DeliveryStreamArn

Type: string

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

FirehoseLogDestinationParameters

Description

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

Members

DeliveryStreamArn

Required: Yes
Type: string

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

InternalException

Description

This exception occurs due to unexpected causes.

Members

message

Required: Yes
Type: string

retryAfterSeconds

Type: int

The number of seconds to wait before retrying the action that caused the exception.

MQBrokerAccessCredentials

Description

The Secrets Manager secret that stores your broker credentials.

Members

BasicAuth

Type: string

The ARN of the Secrets Manager secret.

MSKAccessCredentials

Description

The Secrets Manager secret that stores your stream credentials.

Members

ClientCertificateTlsAuth

Type: string

The ARN of the Secrets Manager secret.

SaslScram512Auth

Type: string

The ARN of the Secrets Manager secret.

NetworkConfiguration

Description

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

Members

awsvpcConfiguration

Type: AwsVpcConfiguration structure

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.

NotFoundException

Description

An entity that you specified does not exist.

Members

message

Type: string

Pipe

Description

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

Members

Arn

Type: string

The ARN of the pipe.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time the pipe was created.

CurrentState

Type: string

The state the pipe is in.

DesiredState

Type: string

The state the pipe should be in.

Enrichment

Type: string

The ARN of the enrichment resource.

LastModifiedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Name

Type: string

The name of the pipe.

Source

Type: string

The ARN of the source resource.

StateReason

Type: string

The reason the pipe is in its current state.

Target

Type: string

The ARN of the target resource.

PipeEnrichmentHttpParameters

Description

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.

Members

HeaderParameters

Type: Associative array of custom strings keys (HeaderKey) to strings

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

PathParameterValues

Type: Array of strings

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

QueryStringParameters

Type: Associative array of custom strings keys (QueryStringKey) to strings

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

PipeEnrichmentParameters

Description

The parameters required to set up enrichment on your pipe.

Members

HttpParameters

Type: PipeEnrichmentHttpParameters structure

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.

InputTemplate

Type: string

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.

PipeLogConfiguration

Description

The logging configuration settings for the pipe.

Members

CloudwatchLogsLogDestination

Type: CloudwatchLogsLogDestination structure

The Amazon CloudWatch Logs logging configuration settings for the pipe.

FirehoseLogDestination

Type: FirehoseLogDestination structure

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

IncludeExecutionData

Type: Array of strings

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.

Level

Type: string

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

S3LogDestination

Type: S3LogDestination structure

The Amazon S3 logging configuration settings for the pipe.

PipeLogConfigurationParameters

Description

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.

Members

CloudwatchLogsLogDestination

Type: CloudwatchLogsLogDestinationParameters structure

The Amazon CloudWatch Logs logging configuration settings for the pipe.

FirehoseLogDestination

Type: FirehoseLogDestinationParameters structure

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

IncludeExecutionData

Type: Array of strings

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.

Level

Required: Yes
Type: string

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.

S3LogDestination

Type: S3LogDestinationParameters structure

The Amazon S3 logging configuration settings for the pipe.

PipeSourceActiveMQBrokerParameters

Description

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

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

Credentials

Required: Yes
Type: MQBrokerAccessCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

QueueName

Required: Yes
Type: string

The name of the destination queue to consume.

PipeSourceDynamoDBStreamParameters

Description

The parameters for using a DynamoDB stream as a source.

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

DeadLetterConfig

Type: DeadLetterConfig structure

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

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

MaximumRecordAgeInSeconds

Type: 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.

MaximumRetryAttempts

Type: 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.

OnPartialBatchItemFailure

Type: string

(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.

ParallelizationFactor

Type: int

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

StartingPosition

Required: Yes
Type: string

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

PipeSourceKinesisStreamParameters

Description

The parameters for using a Kinesis stream as a source.

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

DeadLetterConfig

Type: DeadLetterConfig structure

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

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

MaximumRecordAgeInSeconds

Type: int

MaximumRetryAttempts

Type: int

OnPartialBatchItemFailure

Type: string

ParallelizationFactor

Type: int

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

StartingPosition

Required: Yes
Type: string

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

StartingPositionTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

PipeSourceManagedStreamingKafkaParameters

Description

The parameters for using an MSK stream as a source.

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

ConsumerGroupID

Type: string

The name of the destination queue to consume.

Credentials

Type: MSKAccessCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

StartingPosition

Type: string

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

TopicName

Required: Yes
Type: string

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

PipeSourceParameters

Description

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

Members

ActiveMQBrokerParameters

Type: PipeSourceActiveMQBrokerParameters structure

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

DynamoDBStreamParameters

Type: PipeSourceDynamoDBStreamParameters structure

The parameters for using a DynamoDB stream as a source.

FilterCriteria

Type: FilterCriteria structure

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.

KinesisStreamParameters

Type: PipeSourceKinesisStreamParameters structure

The parameters for using a Kinesis stream as a source.

ManagedStreamingKafkaParameters

Type: PipeSourceManagedStreamingKafkaParameters structure

The parameters for using an MSK stream as a source.

RabbitMQBrokerParameters

Type: PipeSourceRabbitMQBrokerParameters structure

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

SelfManagedKafkaParameters

Type: PipeSourceSelfManagedKafkaParameters structure

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

SqsQueueParameters

Type: PipeSourceSqsQueueParameters structure

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

PipeSourceRabbitMQBrokerParameters

Description

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

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

Credentials

Required: Yes
Type: MQBrokerAccessCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

QueueName

Required: Yes
Type: string

The name of the destination queue to consume.

VirtualHost

Type: string

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

PipeSourceSelfManagedKafkaParameters

Description

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

Members

AdditionalBootstrapServers

Type: Array of strings

An array of server URLs.

BatchSize

Type: int

The maximum number of records to include in each batch.

ConsumerGroupID

Type: string

The name of the destination queue to consume.

Credentials

Type: SelfManagedKafkaAccessConfigurationCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

ServerRootCaCertificate

Type: string

The ARN of the Secrets Manager secret used for certification.

StartingPosition

Type: string

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

TopicName

Required: Yes
Type: string

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

Vpc

Type: SelfManagedKafkaAccessConfigurationVpc structure

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

PipeSourceSqsQueueParameters

Description

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

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

PipeTargetBatchJobParameters

Description

The parameters for using an Batch job as a target.

Members

ArrayProperties

Type: BatchArrayProperties structure

ContainerOverrides

Type: BatchContainerOverrides structure

The overrides that are sent to a container.

DependsOn

Type: Array of BatchJobDependency structures

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.

JobDefinition

Required: Yes
Type: string

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.

JobName

Required: Yes
Type: string

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 (_).

Parameters

Type: Associative array of custom strings keys (String) to strings

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.

RetryStrategy

Type: BatchRetryStrategy structure

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.

PipeTargetCloudWatchLogsParameters

Description

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

Members

LogStreamName

Type: string

The name of the log stream.

Timestamp

Type: string

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

PipeTargetEcsTaskParameters

Description

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

Members

CapacityProviderStrategy

Type: Array of CapacityProviderStrategyItem structures

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.

EnableECSManagedTags

Type: boolean

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.

EnableExecuteCommand

Type: boolean

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.

Group

Type: string

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

LaunchType

Type: string

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.

NetworkConfiguration

Type: NetworkConfiguration structure

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.

Overrides

Type: EcsTaskOverride structure

The overrides that are associated with a task.

PlacementConstraints

Type: Array of PlacementConstraint structures

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).

PlacementStrategy

Type: Array of PlacementStrategy structures

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

PlatformVersion

Type: string

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.

PropagateTags

Type: string

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.

ReferenceId

Type: string

The reference ID to use for the task.

Tags

Type: Array of Tag structures

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.

TaskCount

Type: int

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

TaskDefinitionArn

Required: Yes
Type: string

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

PipeTargetEventBridgeEventBusParameters

Description

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

Members

DetailType

Type: string

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

EndpointId

Type: string

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.

Resources

Type: Array of strings

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

Source

Type: string

The source of the event.

Time

Type: string

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

PipeTargetHttpParameters

Description

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

Members

HeaderParameters

Type: Associative array of custom strings keys (HeaderKey) to strings

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

PathParameterValues

Type: Array of strings

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

QueryStringParameters

Type: Associative array of custom strings keys (QueryStringKey) to strings

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

PipeTargetKinesisStreamParameters

Description

The parameters for using a Kinesis stream as a target.

Members

PartitionKey

Required: Yes
Type: string

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

Description

The parameters for using a Lambda function as a target.

Members

InvocationType

Type: string

Specify whether to invoke the function synchronously or asynchronously.

REQUEST_RESPONSE (default) - Invoke synchronously. This corresponds to the RequestResponse option in the InvocationType parameter for the Lambda Invoke API.
FIRE_AND_FORGET - Invoke asynchronously. This corresponds to the Event option in the InvocationType parameter for the Lambda Invoke API.

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

PipeTargetParameters

Description

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.

Members

BatchJobParameters

Type: PipeTargetBatchJobParameters structure

The parameters for using an Batch job as a target.

CloudWatchLogsParameters

Type: PipeTargetCloudWatchLogsParameters structure

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

EcsTaskParameters

Type: PipeTargetEcsTaskParameters structure

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

EventBridgeEventBusParameters

Type: PipeTargetEventBridgeEventBusParameters structure

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

HttpParameters

Type: PipeTargetHttpParameters structure

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

InputTemplate

Type: string

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.

KinesisStreamParameters

Type: PipeTargetKinesisStreamParameters structure

The parameters for using a Kinesis stream as a target.

LambdaFunctionParameters

Type: PipeTargetLambdaFunctionParameters structure

The parameters for using a Lambda function as a target.

RedshiftDataParameters

Type: PipeTargetRedshiftDataParameters structure

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

SageMakerPipelineParameters

Type: PipeTargetSageMakerPipelineParameters structure

The parameters for using a SageMaker pipeline as a target.

SqsQueueParameters

Type: PipeTargetSqsQueueParameters structure

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

StepFunctionStateMachineParameters

Type: PipeTargetStateMachineParameters structure

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

PipeTargetRedshiftDataParameters

Description

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

Members

Database

Required: Yes
Type: string

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

DbUser

Type: string

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

SecretManagerArn

Type: string

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

Sqls

Required: Yes
Type: Array of strings

The SQL statement text to run.

StatementName

Type: string

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

WithEvent

Type: boolean

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

PipeTargetSageMakerPipelineParameters

Description

The parameters for using a SageMaker pipeline as a target.

Members

PipelineParameterList

Type: Array of SageMakerPipelineParameter structures

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

PipeTargetSqsQueueParameters

Description

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

Members

MessageDeduplicationId

Type: string

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

The token used for deduplication of sent messages.

MessageGroupId

Type: string

The FIFO message group ID to use as the target.

PipeTargetStateMachineParameters

Description

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

Members

InvocationType

Type: string

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

REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the Step Functions API Reference.

REQUEST_RESPONSE is not supported for STANDARD state machine workflows.
FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the Step Functions API Reference.

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

PlacementConstraint

Description

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

Members

expression

Type: string

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.

type

Type: string

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

Description

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.

Members

field

Type: string

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.

type

Type: string

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).

S3LogDestination

Description

The Amazon S3 logging configuration settings for the pipe.

Members

BucketName

Type: string

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

BucketOwner

Type: string

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

OutputFormat

Type: string

The format EventBridge uses for the log records.

json: JSON
plain: Plain text
w3c: W3C extended logging file format

Prefix

Type: string

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.

S3LogDestinationParameters

Description

The Amazon S3 logging configuration settings for the pipe.

Members

BucketName

Required: Yes
Type: string

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

BucketOwner

Required: Yes
Type: string

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

OutputFormat

Type: string

How EventBridge should format the log records.

json: JSON
plain: Plain text
w3c: W3C extended logging file format

Prefix

Type: string

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.

SageMakerPipelineParameter

Description

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

Members

Name

Required: Yes
Type: string

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

Value

Required: Yes
Type: string

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

SelfManagedKafkaAccessConfigurationCredentials

Description

The Secrets Manager secret that stores your stream credentials.

Members

BasicAuth

Type: string

The ARN of the Secrets Manager secret.

ClientCertificateTlsAuth

Type: string

The ARN of the Secrets Manager secret.

SaslScram256Auth

Type: string

The ARN of the Secrets Manager secret.

SaslScram512Auth

Type: string

The ARN of the Secrets Manager secret.

SelfManagedKafkaAccessConfigurationVpc

Description

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

Members

SecurityGroup

Type: Array of strings

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.

Subnets

Type: Array of strings

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

ServiceQuotaExceededException

Description

A quota has been exceeded.

Members

message

Required: Yes
Type: string

quotaCode

Required: Yes
Type: string

The identifier of the quota that caused the exception.

resourceId

Required: Yes
Type: string

The ID of the resource that caused the exception.

resourceType

Required: Yes
Type: string

The type of resource that caused the exception.

serviceCode

Required: Yes
Type: string

The identifier of the service that caused the exception.

ThrottlingException

Description

An action was throttled.

Members

message

Required: Yes
Type: string

quotaCode

Type: string

The identifier of the quota that caused the exception.

retryAfterSeconds

Type: int

The number of seconds to wait before retrying the action that caused the exception.

serviceCode

Type: string

The identifier of the service that caused the exception.

UpdatePipeSourceActiveMQBrokerParameters

Description

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

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

Credentials

Required: Yes
Type: MQBrokerAccessCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

UpdatePipeSourceDynamoDBStreamParameters

Description

The parameters for using a DynamoDB stream as a source.

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

DeadLetterConfig

Type: DeadLetterConfig structure

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

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

MaximumRecordAgeInSeconds

Type: int

MaximumRetryAttempts

Type: int

OnPartialBatchItemFailure

Type: string

ParallelizationFactor

Type: int

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

UpdatePipeSourceKinesisStreamParameters

Description

The parameters for using a Kinesis stream as a source.

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

DeadLetterConfig

Type: DeadLetterConfig structure

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

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

MaximumRecordAgeInSeconds

Type: int

MaximumRetryAttempts

Type: int

OnPartialBatchItemFailure

Type: string

ParallelizationFactor

Type: int

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

UpdatePipeSourceManagedStreamingKafkaParameters

Description

The parameters for using an MSK stream as a source.

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

Credentials

Type: MSKAccessCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

UpdatePipeSourceParameters

Description

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

Members

ActiveMQBrokerParameters

Type: UpdatePipeSourceActiveMQBrokerParameters structure

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

DynamoDBStreamParameters

Type: UpdatePipeSourceDynamoDBStreamParameters structure

The parameters for using a DynamoDB stream as a source.

FilterCriteria

Type: FilterCriteria structure

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.

KinesisStreamParameters

Type: UpdatePipeSourceKinesisStreamParameters structure

The parameters for using a Kinesis stream as a source.

ManagedStreamingKafkaParameters

Type: UpdatePipeSourceManagedStreamingKafkaParameters structure

The parameters for using an MSK stream as a source.

RabbitMQBrokerParameters

Type: UpdatePipeSourceRabbitMQBrokerParameters structure

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

SelfManagedKafkaParameters

Type: UpdatePipeSourceSelfManagedKafkaParameters structure

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

SqsQueueParameters

Type: UpdatePipeSourceSqsQueueParameters structure

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

UpdatePipeSourceRabbitMQBrokerParameters

Description

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

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

Credentials

Required: Yes
Type: MQBrokerAccessCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

UpdatePipeSourceSelfManagedKafkaParameters

Description

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

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

Credentials

Type: SelfManagedKafkaAccessConfigurationCredentials structure

The credentials needed to access the resource.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

ServerRootCaCertificate

Type: string

The ARN of the Secrets Manager secret used for certification.

Vpc

Type: SelfManagedKafkaAccessConfigurationVpc structure

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

UpdatePipeSourceSqsQueueParameters

Description

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

Members

BatchSize

Type: int

The maximum number of records to include in each batch.

MaximumBatchingWindowInSeconds

Type: int

The maximum length of a time to wait for events.

ValidationException

Description

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

Members

fieldList

Type: Array of ValidationExceptionField structures

The list of fields for which validation failed and the corresponding failure messages.

message

Type: string

ValidationExceptionField

Description

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

Members

message

Required: Yes
Type: string

The message of the exception.

name

Required: Yes
Type: string

The name of the exception.

Amazon EventBridge Pipes 2015-10-07

Operation Summary

Paginators

Operations

CreatePipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeletePipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribePipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListPipes

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListTagsForResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StartPipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

StopPipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

TagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

UntagResource

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

UpdatePipe

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details