'2.0', 'service' => '

Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion.

', 'operations' => [ 'CreatePipeline' => '

Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

', 'DeletePipeline' => '

Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines.

', 'GetPipeline' => '

Retrieves information about an OpenSearch Ingestion pipeline.

', 'GetPipelineBlueprint' => '

Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a CreatePipeline request. For more information, see Using blueprints to create a pipeline.

', 'GetPipelineChangeProgress' => '

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.

For more information, see Tracking the status of pipeline creation.

', 'ListPipelineBlueprints' => '

Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline.

', 'ListPipelines' => '

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

', 'ListTagsForResource' => '

Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

', 'StartPipeline' => '

Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.

', 'StopPipeline' => '

Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline.

', 'TagResource' => '

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

', 'UntagResource' => '

Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

', 'UpdatePipeline' => '

Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.

', 'ValidatePipeline' => '

Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines.

', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '

You don\'t have permissions to access the resource.

', 'refs' => [], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'LogPublishingOptions$IsLoggingEnabled' => '

Whether logs should be published.

', 'ValidatePipelineResponse$isValid' => '

A boolean indicating whether or not the pipeline configuration is valid.

', ], ], 'ChangeProgressStage' => [ 'base' => '

Progress details for a specific stage of a pipeline configuration change.

', 'refs' => [ 'ChangeProgressStageList$member' => NULL, ], ], 'ChangeProgressStageList' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$ChangeProgressStages' => '

Information about the stages that the pipeline is going through to perform the configuration change.

', ], ], 'ChangeProgressStageStatuses' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Status' => '

The current status of the stage that the change is in.

', ], ], 'ChangeProgressStatus' => [ 'base' => '

The progress details of a pipeline configuration change.

', 'refs' => [ 'ChangeProgressStatusList$member' => NULL, ], ], 'ChangeProgressStatusList' => [ 'base' => NULL, 'refs' => [ 'GetPipelineChangeProgressResponse$ChangeProgressStatuses' => '

The current status of the change happening on the pipeline.

', ], ], 'ChangeProgressStatuses' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$Status' => '

The overall status of the pipeline configuration change.

', ], ], 'CloudWatchLogDestination' => [ 'base' => '

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.

', 'refs' => [ 'LogPublishingOptions$CloudWatchLogDestination' => '

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.

', ], ], 'ConflictException' => [ 'base' => '

The client attempted to remove a resource that is currently in use.

', 'refs' => [], ], 'CreatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineBlueprintRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineBlueprintResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineChangeProgressRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineChangeProgressResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'IngestEndpointUrlsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$IngestEndpointUrls' => '

The ingestion endpoints for the pipeline, which you can send data to.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStatus$TotalNumberOfStages' => '

The total number of stages required for the pipeline configuration change.

', 'Pipeline$MinUnits' => '

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

', 'Pipeline$MaxUnits' => '

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

', ], ], 'InternalException' => [ 'base' => '

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

', 'refs' => [], ], 'InvalidPaginationTokenException' => [ 'base' => '

An invalid pagination token provided in the request.

', 'refs' => [], ], 'LimitExceededException' => [ 'base' => '

You attempted to create more than the allowed number of tags.

', 'refs' => [], ], 'ListPipelineBlueprintsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelineBlueprintsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPipelinesResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'LogGroup' => [ 'base' => NULL, 'refs' => [ 'CloudWatchLogDestination$LogGroup' => '

The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/OpenSearchService/IngestionService/my-pipeline.

', ], ], 'LogPublishingOptions' => [ 'base' => '

Container for the values required to configure logging for the pipeline. If you don\'t specify these values, OpenSearch Ingestion will not publish logs from your application to CloudWatch Logs.

', 'refs' => [ 'CreatePipelineRequest$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', 'Pipeline$LogPublishingOptions' => '

Key-value pairs that represent log publishing settings.

', 'UpdatePipelineRequest$LogPublishingOptions' => '

Key-value pairs to configure log publishing.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$MaxResults' => '

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesRequest$NextToken' => '

If your initial ListPipelines operation returns a nextToken, you can include the returned nextToken in subsequent ListPipelines operations, which returns results in the next page.

', 'ListPipelinesResponse$NextToken' => '

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

', ], ], 'Pipeline' => [ 'base' => '

Information about an existing OpenSearch Ingestion pipeline.

', 'refs' => [ 'CreatePipelineResponse$Pipeline' => '

Container for information about the created pipeline.

', 'GetPipelineResponse$Pipeline' => '

Detailed information about the requested pipeline.

', 'StartPipelineResponse$Pipeline' => NULL, 'StopPipelineResponse$Pipeline' => NULL, 'UpdatePipelineResponse$Pipeline' => '

Container for information about the updated pipeline.

', ], ], 'PipelineArn' => [ 'base' => NULL, 'refs' => [ 'ListTagsForResourceRequest$Arn' => '

The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.

', 'PipelineSummary$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'TagResourceRequest$Arn' => '

The Amazon Resource Name (ARN) of the pipeline to tag.

', 'UntagResourceRequest$Arn' => '

The Amazon Resource Name (ARN) of the pipeline to remove tags from.

', ], ], 'PipelineBlueprint' => [ 'base' => '

Container for information about an OpenSearch Ingestion blueprint.

', 'refs' => [ 'GetPipelineBlueprintResponse$Blueprint' => '

The requested blueprint in YAML format.

', ], ], 'PipelineBlueprintSummary' => [ 'base' => '

A summary of an OpenSearch Ingestion blueprint.

', 'refs' => [ 'PipelineBlueprintsSummaryList$member' => NULL, ], ], 'PipelineBlueprintsSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelineBlueprintsResponse$Blueprints' => '

A list of available blueprints for Data Prepper.

', ], ], 'PipelineConfigurationBody' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineConfigurationBody' => '

The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.

', 'UpdatePipelineRequest$PipelineConfigurationBody' => '

The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.

', 'ValidatePipelineRequest$PipelineConfigurationBody' => '

The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \\n.

', ], ], 'PipelineName' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$PipelineName' => '

The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

', 'DeletePipelineRequest$PipelineName' => '

The name of the pipeline to delete.

', 'GetPipelineChangeProgressRequest$PipelineName' => '

The name of the pipeline.

', 'GetPipelineRequest$PipelineName' => '

The name of the pipeline to get information about.

', 'PipelineSummary$PipelineName' => '

The name of the pipeline.

', 'StartPipelineRequest$PipelineName' => '

The name of the pipeline to start.

', 'StopPipelineRequest$PipelineName' => '

The name of the pipeline to stop.

', 'UpdatePipelineRequest$PipelineName' => '

The name of the pipeline to update.

', ], ], 'PipelineStatus' => [ 'base' => NULL, 'refs' => [ 'Pipeline$Status' => '

The current status of the pipeline.

', 'PipelineSummary$Status' => '

The current status of the pipeline.

', ], ], 'PipelineStatusReason' => [ 'base' => '

Information about a pipeline\'s current status.

', 'refs' => [ 'Pipeline$StatusReason' => '

The reason for the current status of the pipeline.

', 'PipelineSummary$StatusReason' => NULL, ], ], 'PipelineSummary' => [ 'base' => '

Summary information for an OpenSearch Ingestion pipeline.

', 'refs' => [ 'PipelineSummaryList$member' => NULL, ], ], 'PipelineSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListPipelinesResponse$Pipelines' => '

A list of all existing Data Prepper pipelines.

', ], ], 'PipelineUnits' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$MinUnits' => '

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

', 'CreatePipelineRequest$MaxUnits' => '

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

', 'PipelineSummary$MinUnits' => '

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

', 'PipelineSummary$MaxUnits' => '

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

', 'UpdatePipelineRequest$MinUnits' => '

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

', 'UpdatePipelineRequest$MaxUnits' => '

The maximum pipeline capacity, in Ingestion Compute Units (ICUs)

', ], ], 'ResourceAlreadyExistsException' => [ 'base' => '

You attempted to create a resource that already exists.

', 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => '

You attempted to access or delete a resource that does not exist.

', 'refs' => [], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'SecurityGroupIds$member' => NULL, ], ], 'SecurityGroupIds' => [ 'base' => NULL, 'refs' => [ 'VpcOptions$SecurityGroupIds' => '

A list of security groups associated with the VPC endpoint.

', ], ], 'StartPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopPipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'String' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$Name' => '

The name of the stage.

', 'ChangeProgressStage$Description' => '

A description of the stage.

', 'GetPipelineBlueprintRequest$BlueprintName' => '

The name of the blueprint to retrieve.

', 'IngestEndpointUrlsList$member' => NULL, 'Pipeline$PipelineName' => '

The name of the pipeline.

', 'Pipeline$PipelineArn' => '

The Amazon Resource Name (ARN) of the pipeline.

', 'Pipeline$PipelineConfigurationBody' => '

The Data Prepper pipeline configuration in YAML format.

', 'PipelineBlueprint$BlueprintName' => '

The name of the blueprint.

', 'PipelineBlueprint$PipelineConfigurationBody' => '

The YAML configuration of the blueprint.

', 'PipelineBlueprintSummary$BlueprintName' => '

The name of the blueprint.

', 'PipelineStatusReason$Description' => '

A description of why a pipeline has a certain status.

', 'StringList$member' => NULL, 'ValidationMessage$Message' => '

The validation message.

', 'VpcEndpoint$VpcEndpointId' => '

The unique identifier of the endpoint.

', 'VpcEndpoint$VpcId' => '

The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.

', ], ], 'StringList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tag keys to remove.

', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'VpcOptions$SubnetIds' => '

A list of subnet IDs associated with the VPC endpoint.

', ], ], 'Tag' => [ 'base' => '

A tag (key-value pair) for an OpenSearch Ingestion pipeline.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag key. Tag keys must be unique for the pipeline to which they are attached.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'CreatePipelineRequest$Tags' => '

List of tags to add to the pipeline upon creation.

', 'ListTagsForResourceResponse$Tags' => '

A list of tags associated with the given pipeline.

', 'TagResourceRequest$Tags' => '

The list of key-value tags to add to the pipeline.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The value assigned to the corresponding tag key. Tag values can be null and don\'t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

', ], ], 'Timestamp' => [ 'base' => NULL, 'refs' => [ 'ChangeProgressStage$LastUpdatedAt' => '

The most recent updated timestamp of the stage.

', 'ChangeProgressStatus$StartTime' => '

The time at which the configuration change is made on the pipeline.

', 'Pipeline$CreatedAt' => '

The date and time when the pipeline was created.

', 'Pipeline$LastUpdatedAt' => '

The date and time when the pipeline was last updated.

', 'PipelineSummary$CreatedAt' => '

The date and time when the pipeline was created.

', 'PipelineSummary$LastUpdatedAt' => '

The date and time when the pipeline was last updated.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidatePipelineRequest' => [ 'base' => NULL, 'refs' => [], ], 'ValidatePipelineResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

An exception for missing or invalid input fields.

', 'refs' => [], ], 'ValidationMessage' => [ 'base' => '

A validation message associated with a ValidatePipeline request in OpenSearch Ingestion.

', 'refs' => [ 'ValidationMessageList$member' => NULL, ], ], 'ValidationMessageList' => [ 'base' => NULL, 'refs' => [ 'ValidatePipelineResponse$Errors' => '

A list of errors if the configuration is invalid.

', ], ], 'VpcEndpoint' => [ 'base' => '

An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.

', 'refs' => [ 'VpcEndpointsList$member' => NULL, ], ], 'VpcEndpointsList' => [ 'base' => NULL, 'refs' => [ 'Pipeline$VpcEndpoints' => '

The VPC interface endpoints that have access to the pipeline.

', ], ], 'VpcOptions' => [ 'base' => '

Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

', 'refs' => [ 'CreatePipelineRequest$VpcOptions' => '

Container for the values required to configure VPC access for the pipeline. If you don\'t specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

', 'VpcEndpoint$VpcOptions' => '

Information about the VPC, including associated subnets and security groups.

', ], ], ],];