import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribePipeRequest, DescribePipeResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribePipeCommand}. */ export interface DescribePipeCommandInput extends DescribePipeRequest { } /** * @public * * The output of {@link DescribePipeCommand}. */ export interface DescribePipeCommandOutput extends DescribePipeResponse, __MetadataBearer { } declare const DescribePipeCommand_base: { new (input: DescribePipeCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribePipeCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { PipesClient, DescribePipeCommand } from "@aws-sdk/client-pipes"; // ES Modules import * // const { PipesClient, DescribePipeCommand } = require("@aws-sdk/client-pipes"); // CommonJS import * // import type { PipesClientConfig } from "@aws-sdk/client-pipes"; * const config = {}; // type is PipesClientConfig * const client = new PipesClient(config); * const input = { // DescribePipeRequest * Name: "STRING_VALUE", // required * }; * const command = new DescribePipeCommand(input); * const response = await client.send(command); * // { // DescribePipeResponse * // Arn: "STRING_VALUE", * // Name: "STRING_VALUE", * // Description: "STRING_VALUE", * // DesiredState: "STRING_VALUE", * // CurrentState: "STRING_VALUE", * // StateReason: "STRING_VALUE", * // Source: "STRING_VALUE", * // SourceParameters: { // PipeSourceParameters * // FilterCriteria: { // FilterCriteria * // Filters: [ // FilterList * // { // Filter * // Pattern: "STRING_VALUE", * // }, * // ], * // }, * // KinesisStreamParameters: { // PipeSourceKinesisStreamParameters * // BatchSize: Number("int"), * // DeadLetterConfig: { // DeadLetterConfig * // Arn: "STRING_VALUE", * // }, * // OnPartialBatchItemFailure: "STRING_VALUE", * // MaximumBatchingWindowInSeconds: Number("int"), * // MaximumRecordAgeInSeconds: Number("int"), * // MaximumRetryAttempts: Number("int"), * // ParallelizationFactor: Number("int"), * // StartingPosition: "STRING_VALUE", // required * // StartingPositionTimestamp: new Date("TIMESTAMP"), * // }, * // DynamoDBStreamParameters: { // PipeSourceDynamoDBStreamParameters * // BatchSize: Number("int"), * // DeadLetterConfig: { * // Arn: "STRING_VALUE", * // }, * // OnPartialBatchItemFailure: "STRING_VALUE", * // MaximumBatchingWindowInSeconds: Number("int"), * // MaximumRecordAgeInSeconds: Number("int"), * // MaximumRetryAttempts: Number("int"), * // ParallelizationFactor: Number("int"), * // StartingPosition: "STRING_VALUE", // required * // }, * // SqsQueueParameters: { // PipeSourceSqsQueueParameters * // BatchSize: Number("int"), * // MaximumBatchingWindowInSeconds: Number("int"), * // }, * // ActiveMQBrokerParameters: { // PipeSourceActiveMQBrokerParameters * // Credentials: { // MQBrokerAccessCredentials Union: only one key present * // BasicAuth: "STRING_VALUE", * // }, * // QueueName: "STRING_VALUE", // required * // BatchSize: Number("int"), * // MaximumBatchingWindowInSeconds: Number("int"), * // }, * // RabbitMQBrokerParameters: { // PipeSourceRabbitMQBrokerParameters * // Credentials: {// Union: only one key present * // BasicAuth: "STRING_VALUE", * // }, * // QueueName: "STRING_VALUE", // required * // VirtualHost: "STRING_VALUE", * // BatchSize: Number("int"), * // MaximumBatchingWindowInSeconds: Number("int"), * // }, * // ManagedStreamingKafkaParameters: { // PipeSourceManagedStreamingKafkaParameters * // TopicName: "STRING_VALUE", // required * // StartingPosition: "STRING_VALUE", * // BatchSize: Number("int"), * // MaximumBatchingWindowInSeconds: Number("int"), * // ConsumerGroupID: "STRING_VALUE", * // Credentials: { // MSKAccessCredentials Union: only one key present * // SaslScram512Auth: "STRING_VALUE", * // ClientCertificateTlsAuth: "STRING_VALUE", * // }, * // }, * // SelfManagedKafkaParameters: { // PipeSourceSelfManagedKafkaParameters * // TopicName: "STRING_VALUE", // required * // StartingPosition: "STRING_VALUE", * // AdditionalBootstrapServers: [ // KafkaBootstrapServers * // "STRING_VALUE", * // ], * // BatchSize: Number("int"), * // MaximumBatchingWindowInSeconds: Number("int"), * // ConsumerGroupID: "STRING_VALUE", * // Credentials: { // SelfManagedKafkaAccessConfigurationCredentials Union: only one key present * // BasicAuth: "STRING_VALUE", * // SaslScram512Auth: "STRING_VALUE", * // SaslScram256Auth: "STRING_VALUE", * // ClientCertificateTlsAuth: "STRING_VALUE", * // }, * // ServerRootCaCertificate: "STRING_VALUE", * // Vpc: { // SelfManagedKafkaAccessConfigurationVpc * // Subnets: [ // SubnetIds * // "STRING_VALUE", * // ], * // SecurityGroup: [ // SecurityGroupIds * // "STRING_VALUE", * // ], * // }, * // }, * // }, * // Enrichment: "STRING_VALUE", * // EnrichmentParameters: { // PipeEnrichmentParameters * // InputTemplate: "STRING_VALUE", * // HttpParameters: { // PipeEnrichmentHttpParameters * // PathParameterValues: [ // PathParameterList * // "STRING_VALUE", * // ], * // HeaderParameters: { // HeaderParametersMap * // "": "STRING_VALUE", * // }, * // QueryStringParameters: { // QueryStringParametersMap * // "": "STRING_VALUE", * // }, * // }, * // }, * // Target: "STRING_VALUE", * // TargetParameters: { // PipeTargetParameters * // InputTemplate: "STRING_VALUE", * // LambdaFunctionParameters: { // PipeTargetLambdaFunctionParameters * // InvocationType: "STRING_VALUE", * // }, * // StepFunctionStateMachineParameters: { // PipeTargetStateMachineParameters * // InvocationType: "STRING_VALUE", * // }, * // KinesisStreamParameters: { // PipeTargetKinesisStreamParameters * // PartitionKey: "STRING_VALUE", // required * // }, * // EcsTaskParameters: { // PipeTargetEcsTaskParameters * // TaskDefinitionArn: "STRING_VALUE", // required * // TaskCount: Number("int"), * // LaunchType: "STRING_VALUE", * // NetworkConfiguration: { // NetworkConfiguration * // awsvpcConfiguration: { // AwsVpcConfiguration * // Subnets: [ // Subnets // required * // "STRING_VALUE", * // ], * // SecurityGroups: [ // SecurityGroups * // "STRING_VALUE", * // ], * // AssignPublicIp: "STRING_VALUE", * // }, * // }, * // PlatformVersion: "STRING_VALUE", * // Group: "STRING_VALUE", * // CapacityProviderStrategy: [ // CapacityProviderStrategy * // { // CapacityProviderStrategyItem * // capacityProvider: "STRING_VALUE", // required * // weight: Number("int"), * // base: Number("int"), * // }, * // ], * // EnableECSManagedTags: true || false, * // EnableExecuteCommand: true || false, * // PlacementConstraints: [ // PlacementConstraints * // { // PlacementConstraint * // type: "STRING_VALUE", * // expression: "STRING_VALUE", * // }, * // ], * // PlacementStrategy: [ // PlacementStrategies * // { // PlacementStrategy * // type: "STRING_VALUE", * // field: "STRING_VALUE", * // }, * // ], * // PropagateTags: "STRING_VALUE", * // ReferenceId: "STRING_VALUE", * // Overrides: { // EcsTaskOverride * // ContainerOverrides: [ // EcsContainerOverrideList * // { // EcsContainerOverride * // Command: [ // StringList * // "STRING_VALUE", * // ], * // Cpu: Number("int"), * // Environment: [ // EcsEnvironmentVariableList * // { // EcsEnvironmentVariable * // name: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // EnvironmentFiles: [ // EcsEnvironmentFileList * // { // EcsEnvironmentFile * // type: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // ], * // Memory: Number("int"), * // MemoryReservation: Number("int"), * // Name: "STRING_VALUE", * // ResourceRequirements: [ // EcsResourceRequirementsList * // { // EcsResourceRequirement * // type: "STRING_VALUE", // required * // value: "STRING_VALUE", // required * // }, * // ], * // }, * // ], * // Cpu: "STRING_VALUE", * // EphemeralStorage: { // EcsEphemeralStorage * // sizeInGiB: Number("int"), // required * // }, * // ExecutionRoleArn: "STRING_VALUE", * // InferenceAcceleratorOverrides: [ // EcsInferenceAcceleratorOverrideList * // { // EcsInferenceAcceleratorOverride * // deviceName: "STRING_VALUE", * // deviceType: "STRING_VALUE", * // }, * // ], * // Memory: "STRING_VALUE", * // TaskRoleArn: "STRING_VALUE", * // }, * // Tags: [ // TagList * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // BatchJobParameters: { // PipeTargetBatchJobParameters * // JobDefinition: "STRING_VALUE", // required * // JobName: "STRING_VALUE", // required * // ArrayProperties: { // BatchArrayProperties * // Size: Number("int"), * // }, * // RetryStrategy: { // BatchRetryStrategy * // Attempts: Number("int"), * // }, * // ContainerOverrides: { // BatchContainerOverrides * // Command: [ * // "STRING_VALUE", * // ], * // Environment: [ // BatchEnvironmentVariableList * // { // BatchEnvironmentVariable * // Name: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // InstanceType: "STRING_VALUE", * // ResourceRequirements: [ // BatchResourceRequirementsList * // { // BatchResourceRequirement * // Type: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // DependsOn: [ // BatchDependsOn * // { // BatchJobDependency * // JobId: "STRING_VALUE", * // Type: "STRING_VALUE", * // }, * // ], * // Parameters: { // BatchParametersMap * // "": "STRING_VALUE", * // }, * // }, * // SqsQueueParameters: { // PipeTargetSqsQueueParameters * // MessageGroupId: "STRING_VALUE", * // MessageDeduplicationId: "STRING_VALUE", * // }, * // HttpParameters: { // PipeTargetHttpParameters * // PathParameterValues: [ * // "STRING_VALUE", * // ], * // HeaderParameters: { * // "": "STRING_VALUE", * // }, * // QueryStringParameters: { * // "": "STRING_VALUE", * // }, * // }, * // RedshiftDataParameters: { // PipeTargetRedshiftDataParameters * // SecretManagerArn: "STRING_VALUE", * // Database: "STRING_VALUE", // required * // DbUser: "STRING_VALUE", * // StatementName: "STRING_VALUE", * // WithEvent: true || false, * // Sqls: [ // Sqls // required * // "STRING_VALUE", * // ], * // }, * // SageMakerPipelineParameters: { // PipeTargetSageMakerPipelineParameters * // PipelineParameterList: [ // SageMakerPipelineParameterList * // { // SageMakerPipelineParameter * // Name: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // }, * // EventBridgeEventBusParameters: { // PipeTargetEventBridgeEventBusParameters * // EndpointId: "STRING_VALUE", * // DetailType: "STRING_VALUE", * // Source: "STRING_VALUE", * // Resources: [ // EventBridgeEventResourceList * // "STRING_VALUE", * // ], * // Time: "STRING_VALUE", * // }, * // CloudWatchLogsParameters: { // PipeTargetCloudWatchLogsParameters * // LogStreamName: "STRING_VALUE", * // Timestamp: "STRING_VALUE", * // }, * // TimestreamParameters: { // PipeTargetTimestreamParameters * // TimeValue: "STRING_VALUE", // required * // EpochTimeUnit: "STRING_VALUE", * // TimeFieldType: "STRING_VALUE", * // TimestampFormat: "STRING_VALUE", * // VersionValue: "STRING_VALUE", // required * // DimensionMappings: [ // DimensionMappings // required * // { // DimensionMapping * // DimensionValue: "STRING_VALUE", // required * // DimensionValueType: "STRING_VALUE", // required * // DimensionName: "STRING_VALUE", // required * // }, * // ], * // SingleMeasureMappings: [ // SingleMeasureMappings * // { // SingleMeasureMapping * // MeasureValue: "STRING_VALUE", // required * // MeasureValueType: "STRING_VALUE", // required * // MeasureName: "STRING_VALUE", // required * // }, * // ], * // MultiMeasureMappings: [ // MultiMeasureMappings * // { // MultiMeasureMapping * // MultiMeasureName: "STRING_VALUE", // required * // MultiMeasureAttributeMappings: [ // MultiMeasureAttributeMappings // required * // { // MultiMeasureAttributeMapping * // MeasureValue: "STRING_VALUE", // required * // MeasureValueType: "STRING_VALUE", // required * // MultiMeasureAttributeName: "STRING_VALUE", // required * // }, * // ], * // }, * // ], * // }, * // }, * // RoleArn: "STRING_VALUE", * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, * // CreationTime: new Date("TIMESTAMP"), * // LastModifiedTime: new Date("TIMESTAMP"), * // LogConfiguration: { // PipeLogConfiguration * // S3LogDestination: { // S3LogDestination * // BucketName: "STRING_VALUE", * // Prefix: "STRING_VALUE", * // BucketOwner: "STRING_VALUE", * // OutputFormat: "STRING_VALUE", * // }, * // FirehoseLogDestination: { // FirehoseLogDestination * // DeliveryStreamArn: "STRING_VALUE", * // }, * // CloudwatchLogsLogDestination: { // CloudwatchLogsLogDestination * // LogGroupArn: "STRING_VALUE", * // }, * // Level: "STRING_VALUE", * // IncludeExecutionData: [ // IncludeExecutionData * // "STRING_VALUE", * // ], * // }, * // KmsKeyIdentifier: "STRING_VALUE", * // }; * * ``` * * @param DescribePipeCommandInput - {@link DescribePipeCommandInput} * @returns {@link DescribePipeCommandOutput} * @see {@link DescribePipeCommandInput} for command's `input` shape. * @see {@link DescribePipeCommandOutput} for command's `response` shape. * @see {@link PipesClientResolvedConfig | config} for PipesClient's `config` shape. * * @throws {@link InternalException} (server fault) *

This exception occurs due to unexpected causes.

* * @throws {@link NotFoundException} (client fault) *

An entity that you specified does not exist.

* * @throws {@link ThrottlingException} (client fault) *

An action was throttled.

* * @throws {@link ValidationException} (client fault) *

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

* * @throws {@link PipesServiceException} *

Base exception class for all service exceptions from Pipes service.

* * * @public */ export declare class DescribePipeCommand extends DescribePipeCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribePipeRequest; output: DescribePipeResponse; }; sdk: { input: DescribePipeCommandInput; output: DescribePipeCommandOutput; }; }; }