SDK for PHP 3.x

Amazon OpenSearch Ingestion 2022-01-01

Client: Aws\OSIS\OSISClient
Service ID: osis
Version: 2022-01-01

This page describes the parameters and results for the operations of the Amazon OpenSearch Ingestion (2022-01-01), and shows how to use the Aws\OSIS\OSISClient object to call the described operations. This documentation is specific to the 2022-01-01 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 */).

CreatePipeline ( array $params = [] )
Creates an OpenSearch Ingestion pipeline.
DeletePipeline ( array $params = [] )
Deletes an OpenSearch Ingestion pipeline.
GetPipeline ( array $params = [] )
Retrieves information about an OpenSearch Ingestion pipeline.
GetPipelineBlueprint ( array $params = [] )
Retrieves information about a specific blueprint for OpenSearch Ingestion.
GetPipelineChangeProgress ( array $params = [] )
Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
ListPipelineBlueprints ( array $params = [] )
Retrieves a list of all available blueprints for Data Prepper.
ListPipelines ( array $params = [] )
Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.
ListTagsForResource ( array $params = [] )
Lists all resource tags associated with an OpenSearch Ingestion pipeline.
StartPipeline ( array $params = [] )
Starts an OpenSearch Ingestion pipeline.
StopPipeline ( array $params = [] )
Stops an OpenSearch Ingestion pipeline.
TagResource ( array $params = [] )
Tags an OpenSearch Ingestion pipeline.
UntagResource ( array $params = [] )
Removes one or more tags from an OpenSearch Ingestion pipeline.
UpdatePipeline ( array $params = [] )
Updates an OpenSearch Ingestion pipeline.
ValidatePipeline ( array $params = [] )
Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

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:

ListPipelines

Operations

CreatePipeline 

$result = $client->createPipeline([/* ... */]);
$promise = $client->createPipelineAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createPipeline([
    'BufferOptions' => [
        'PersistentBufferEnabled' => true || false, // REQUIRED
    ],
    'EncryptionAtRestOptions' => [
        'KmsKeyArn' => '<string>', // REQUIRED
    ],
    'LogPublishingOptions' => [
        'CloudWatchLogDestination' => [
            'LogGroup' => '<string>', // REQUIRED
        ],
        'IsLoggingEnabled' => true || false,
    ],
    'MaxUnits' => <integer>, // REQUIRED
    'MinUnits' => <integer>, // REQUIRED
    'PipelineConfigurationBody' => '<string>', // REQUIRED
    'PipelineName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcOptions' => [
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...], // REQUIRED
        'VpcAttachmentOptions' => [
            'AttachToVpc' => true || false, // REQUIRED
            'CidrBlock' => '<string>',
        ],
        'VpcEndpointManagement' => 'CUSTOMER|SERVICE',
    ],
]);

Parameter Details

Members
BufferOptions
Type: BufferOptions structure

Key-value pairs to configure persistent buffering for the pipeline.

EncryptionAtRestOptions
Type: EncryptionAtRestOptions structure

Key-value pairs to configure encryption for data that is written to a persistent buffer.

LogPublishingOptions
Type: LogPublishingOptions structure

Key-value pairs to configure log publishing.

MaxUnits
Required: Yes
Type: int

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

MinUnits
Required: Yes
Type: int

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

PipelineConfigurationBody
Required: Yes
Type: string

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
Required: Yes
Type: string

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.

Tags
Type: Array of Tag structures

List of tags to add to the pipeline upon creation.

VpcOptions
Type: VpcOptions structure

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.

Result Syntax

[
    'Pipeline' => [
        'BufferOptions' => [
            'PersistentBufferEnabled' => true || false,
        ],
        'CreatedAt' => <DateTime>,
        'Destinations' => [
            [
                'Endpoint' => '<string>',
                'ServiceName' => '<string>',
            ],
            // ...
        ],
        'EncryptionAtRestOptions' => [
            'KmsKeyArn' => '<string>',
        ],
        'IngestEndpointUrls' => ['<string>', ...],
        'LastUpdatedAt' => <DateTime>,
        'LogPublishingOptions' => [
            'CloudWatchLogDestination' => [
                'LogGroup' => '<string>',
            ],
            'IsLoggingEnabled' => true || false,
        ],
        'MaxUnits' => <integer>,
        'MinUnits' => <integer>,
        'PipelineArn' => '<string>',
        'PipelineConfigurationBody' => '<string>',
        'PipelineName' => '<string>',
        'ServiceVpcEndpoints' => [
            [
                'ServiceName' => 'OPENSEARCH_SERVERLESS',
                'VpcEndpointId' => '<string>',
            ],
            // ...
        ],
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|STARTING|START_FAILED|STOPPING|STOPPED',
        'StatusReason' => [
            'Description' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointService' => '<string>',
        'VpcEndpoints' => [
            [
                'VpcEndpointId' => '<string>',
                'VpcId' => '<string>',
                'VpcOptions' => [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcAttachmentOptions' => [
                        'AttachToVpc' => true || false,
                        'CidrBlock' => '<string>',
                    ],
                    'VpcEndpointManagement' => 'CUSTOMER|SERVICE',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
Pipeline
Type: Pipeline structure

Container for information about the created pipeline.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

LimitExceededException:

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

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

ResourceAlreadyExistsException:

You attempted to create a resource that already exists.

ResourceNotFoundException:

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

DeletePipeline 

$result = $client->deletePipeline([/* ... */]);
$promise = $client->deletePipelineAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Members
PipelineName
Required: Yes
Type: string

The name of the pipeline to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

ResourceNotFoundException:

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

ConflictException:

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

GetPipeline 

$result = $client->getPipeline([/* ... */]);
$promise = $client->getPipelineAsync([/* ... */]);

Retrieves information about an OpenSearch Ingestion pipeline.

Parameter Syntax

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

Parameter Details

Members
PipelineName
Required: Yes
Type: string

The name of the pipeline.

Result Syntax

[
    'Pipeline' => [
        'BufferOptions' => [
            'PersistentBufferEnabled' => true || false,
        ],
        'CreatedAt' => <DateTime>,
        'Destinations' => [
            [
                'Endpoint' => '<string>',
                'ServiceName' => '<string>',
            ],
            // ...
        ],
        'EncryptionAtRestOptions' => [
            'KmsKeyArn' => '<string>',
        ],
        'IngestEndpointUrls' => ['<string>', ...],
        'LastUpdatedAt' => <DateTime>,
        'LogPublishingOptions' => [
            'CloudWatchLogDestination' => [
                'LogGroup' => '<string>',
            ],
            'IsLoggingEnabled' => true || false,
        ],
        'MaxUnits' => <integer>,
        'MinUnits' => <integer>,
        'PipelineArn' => '<string>',
        'PipelineConfigurationBody' => '<string>',
        'PipelineName' => '<string>',
        'ServiceVpcEndpoints' => [
            [
                'ServiceName' => 'OPENSEARCH_SERVERLESS',
                'VpcEndpointId' => '<string>',
            ],
            // ...
        ],
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|STARTING|START_FAILED|STOPPING|STOPPED',
        'StatusReason' => [
            'Description' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointService' => '<string>',
        'VpcEndpoints' => [
            [
                'VpcEndpointId' => '<string>',
                'VpcId' => '<string>',
                'VpcOptions' => [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcAttachmentOptions' => [
                        'AttachToVpc' => true || false,
                        'CidrBlock' => '<string>',
                    ],
                    'VpcEndpointManagement' => 'CUSTOMER|SERVICE',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
Pipeline
Type: Pipeline structure

Detailed information about the requested pipeline.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

ResourceNotFoundException:

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

GetPipelineBlueprint 

$result = $client->getPipelineBlueprint([/* ... */]);
$promise = $client->getPipelineBlueprintAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getPipelineBlueprint([
    'BlueprintName' => '<string>', // REQUIRED
    'Format' => '<string>',
]);

Parameter Details

Members
BlueprintName
Required: Yes
Type: string

The name of the blueprint to retrieve.

Format
Type: string

The format format of the blueprint to retrieve.

Result Syntax

[
    'Blueprint' => [
        'BlueprintName' => '<string>',
        'DisplayDescription' => '<string>',
        'DisplayName' => '<string>',
        'PipelineConfigurationBody' => '<string>',
        'Service' => '<string>',
        'UseCase' => '<string>',
    ],
    'Format' => '<string>',
]

Result Details

Members
Blueprint
Type: PipelineBlueprint structure

The requested blueprint in YAML format.

Format
Type: string

The format of the blueprint.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

AccessDeniedException:

You don't have permissions to access the resource.

InternalException:

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

ValidationException:

An exception for missing or invalid input fields.

ResourceNotFoundException:

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

GetPipelineChangeProgress 

$result = $client->getPipelineChangeProgress([/* ... */]);
$promise = $client->getPipelineChangeProgressAsync([/* ... */]);

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.

Parameter Syntax

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

Parameter Details

Members
PipelineName
Required: Yes
Type: string

The name of the pipeline.

Result Syntax

[
    'ChangeProgressStatuses' => [
        [
            'ChangeProgressStages' => [
                [
                    'Description' => '<string>',
                    'LastUpdatedAt' => <DateTime>,
                    'Name' => '<string>',
                    'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED',
                ],
                // ...
            ],
            'StartTime' => <DateTime>,
            'Status' => 'PENDING|IN_PROGRESS|COMPLETED|FAILED',
            'TotalNumberOfStages' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
ChangeProgressStatuses
Type: Array of ChangeProgressStatus structures

The current status of the change happening on the pipeline.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

ResourceNotFoundException:

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

ListPipelineBlueprints 

$result = $client->listPipelineBlueprints([/* ... */]);
$promise = $client->listPipelineBlueprintsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPipelineBlueprints([
]);

Parameter Details

Members

Result Syntax

[
    'Blueprints' => [
        [
            'BlueprintName' => '<string>',
            'DisplayDescription' => '<string>',
            'DisplayName' => '<string>',
            'Service' => '<string>',
            'UseCase' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Blueprints
Type: Array of PipelineBlueprintSummary structures

A list of available blueprints for Data Prepper.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

InvalidPaginationTokenException:

An invalid pagination token provided in the request.

ListPipelines 

$result = $client->listPipelines([/* ... */]);
$promise = $client->listPipelinesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPipelines([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

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

NextToken
Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'Pipelines' => [
        [
            'CreatedAt' => <DateTime>,
            'Destinations' => [
                [
                    'Endpoint' => '<string>',
                    'ServiceName' => '<string>',
                ],
                // ...
            ],
            'LastUpdatedAt' => <DateTime>,
            'MaxUnits' => <integer>,
            'MinUnits' => <integer>,
            'PipelineArn' => '<string>',
            'PipelineName' => '<string>',
            'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|STARTING|START_FAILED|STOPPING|STOPPED',
            'StatusReason' => [
                'Description' => '<string>',
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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.

Pipelines
Type: Array of PipelineSummary structures

A list of all existing Data Prepper pipelines.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

InvalidPaginationTokenException:

An invalid pagination token provided in the request.

ListTagsForResource 

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

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

Parameter Syntax

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

Parameter Details

Members
Arn
Required: Yes
Type: string

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

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

A list of tags associated with the given pipeline.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

ResourceNotFoundException:

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

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

StartPipeline 

$result = $client->startPipeline([/* ... */]);
$promise = $client->startPipelineAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Members
PipelineName
Required: Yes
Type: string

The name of the pipeline to start.

Result Syntax

[
    'Pipeline' => [
        'BufferOptions' => [
            'PersistentBufferEnabled' => true || false,
        ],
        'CreatedAt' => <DateTime>,
        'Destinations' => [
            [
                'Endpoint' => '<string>',
                'ServiceName' => '<string>',
            ],
            // ...
        ],
        'EncryptionAtRestOptions' => [
            'KmsKeyArn' => '<string>',
        ],
        'IngestEndpointUrls' => ['<string>', ...],
        'LastUpdatedAt' => <DateTime>,
        'LogPublishingOptions' => [
            'CloudWatchLogDestination' => [
                'LogGroup' => '<string>',
            ],
            'IsLoggingEnabled' => true || false,
        ],
        'MaxUnits' => <integer>,
        'MinUnits' => <integer>,
        'PipelineArn' => '<string>',
        'PipelineConfigurationBody' => '<string>',
        'PipelineName' => '<string>',
        'ServiceVpcEndpoints' => [
            [
                'ServiceName' => 'OPENSEARCH_SERVERLESS',
                'VpcEndpointId' => '<string>',
            ],
            // ...
        ],
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|STARTING|START_FAILED|STOPPING|STOPPED',
        'StatusReason' => [
            'Description' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointService' => '<string>',
        'VpcEndpoints' => [
            [
                'VpcEndpointId' => '<string>',
                'VpcId' => '<string>',
                'VpcOptions' => [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcAttachmentOptions' => [
                        'AttachToVpc' => true || false,
                        'CidrBlock' => '<string>',
                    ],
                    'VpcEndpointManagement' => 'CUSTOMER|SERVICE',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
Pipeline
Type: Pipeline structure

Information about an existing OpenSearch Ingestion pipeline.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

AccessDeniedException:

You don't have permissions to access the resource.

ConflictException:

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

InternalException:

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

ResourceNotFoundException:

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

ValidationException:

An exception for missing or invalid input fields.

StopPipeline 

$result = $client->stopPipeline([/* ... */]);
$promise = $client->stopPipelineAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Members
PipelineName
Required: Yes
Type: string

The name of the pipeline to stop.

Result Syntax

[
    'Pipeline' => [
        'BufferOptions' => [
            'PersistentBufferEnabled' => true || false,
        ],
        'CreatedAt' => <DateTime>,
        'Destinations' => [
            [
                'Endpoint' => '<string>',
                'ServiceName' => '<string>',
            ],
            // ...
        ],
        'EncryptionAtRestOptions' => [
            'KmsKeyArn' => '<string>',
        ],
        'IngestEndpointUrls' => ['<string>', ...],
        'LastUpdatedAt' => <DateTime>,
        'LogPublishingOptions' => [
            'CloudWatchLogDestination' => [
                'LogGroup' => '<string>',
            ],
            'IsLoggingEnabled' => true || false,
        ],
        'MaxUnits' => <integer>,
        'MinUnits' => <integer>,
        'PipelineArn' => '<string>',
        'PipelineConfigurationBody' => '<string>',
        'PipelineName' => '<string>',
        'ServiceVpcEndpoints' => [
            [
                'ServiceName' => 'OPENSEARCH_SERVERLESS',
                'VpcEndpointId' => '<string>',
            ],
            // ...
        ],
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|STARTING|START_FAILED|STOPPING|STOPPED',
        'StatusReason' => [
            'Description' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointService' => '<string>',
        'VpcEndpoints' => [
            [
                'VpcEndpointId' => '<string>',
                'VpcId' => '<string>',
                'VpcOptions' => [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcAttachmentOptions' => [
                        'AttachToVpc' => true || false,
                        'CidrBlock' => '<string>',
                    ],
                    'VpcEndpointManagement' => 'CUSTOMER|SERVICE',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
Pipeline
Type: Pipeline structure

Information about an existing OpenSearch Ingestion pipeline.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

AccessDeniedException:

You don't have permissions to access the resource.

ConflictException:

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

InternalException:

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

ResourceNotFoundException:

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

ValidationException:

An exception for missing or invalid input fields.

TagResource 

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

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

Parameter Syntax

$result = $client->tagResource([
    'Arn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
Arn
Required: Yes
Type: string

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

Tags
Required: Yes
Type: Array of Tag structures

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

LimitExceededException:

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

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

ResourceNotFoundException:

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

UntagResource 

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

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

Parameter Syntax

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

Parameter Details

Members
Arn
Required: Yes
Type: string

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

TagKeys
Required: Yes
Type: Array of strings

The tag keys to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

ResourceNotFoundException:

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

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

UpdatePipeline 

$result = $client->updatePipeline([/* ... */]);
$promise = $client->updatePipelineAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updatePipeline([
    'BufferOptions' => [
        'PersistentBufferEnabled' => true || false, // REQUIRED
    ],
    'EncryptionAtRestOptions' => [
        'KmsKeyArn' => '<string>', // REQUIRED
    ],
    'LogPublishingOptions' => [
        'CloudWatchLogDestination' => [
            'LogGroup' => '<string>', // REQUIRED
        ],
        'IsLoggingEnabled' => true || false,
    ],
    'MaxUnits' => <integer>,
    'MinUnits' => <integer>,
    'PipelineConfigurationBody' => '<string>',
    'PipelineName' => '<string>', // REQUIRED
]);

Parameter Details

Members
BufferOptions
Type: BufferOptions structure

Key-value pairs to configure persistent buffering for the pipeline.

EncryptionAtRestOptions
Type: EncryptionAtRestOptions structure

Key-value pairs to configure encryption for data that is written to a persistent buffer.

LogPublishingOptions
Type: LogPublishingOptions structure

Key-value pairs to configure log publishing.

MaxUnits
Type: int

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

MinUnits
Type: int

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

PipelineConfigurationBody
Type: string

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
Required: Yes
Type: string

The name of the pipeline to update.

Result Syntax

[
    'Pipeline' => [
        'BufferOptions' => [
            'PersistentBufferEnabled' => true || false,
        ],
        'CreatedAt' => <DateTime>,
        'Destinations' => [
            [
                'Endpoint' => '<string>',
                'ServiceName' => '<string>',
            ],
            // ...
        ],
        'EncryptionAtRestOptions' => [
            'KmsKeyArn' => '<string>',
        ],
        'IngestEndpointUrls' => ['<string>', ...],
        'LastUpdatedAt' => <DateTime>,
        'LogPublishingOptions' => [
            'CloudWatchLogDestination' => [
                'LogGroup' => '<string>',
            ],
            'IsLoggingEnabled' => true || false,
        ],
        'MaxUnits' => <integer>,
        'MinUnits' => <integer>,
        'PipelineArn' => '<string>',
        'PipelineConfigurationBody' => '<string>',
        'PipelineName' => '<string>',
        'ServiceVpcEndpoints' => [
            [
                'ServiceName' => 'OPENSEARCH_SERVERLESS',
                'VpcEndpointId' => '<string>',
            ],
            // ...
        ],
        'Status' => 'CREATING|ACTIVE|UPDATING|DELETING|CREATE_FAILED|UPDATE_FAILED|STARTING|START_FAILED|STOPPING|STOPPED',
        'StatusReason' => [
            'Description' => '<string>',
        ],
        'Tags' => [
            [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'VpcEndpointService' => '<string>',
        'VpcEndpoints' => [
            [
                'VpcEndpointId' => '<string>',
                'VpcId' => '<string>',
                'VpcOptions' => [
                    'SecurityGroupIds' => ['<string>', ...],
                    'SubnetIds' => ['<string>', ...],
                    'VpcAttachmentOptions' => [
                        'AttachToVpc' => true || false,
                        'CidrBlock' => '<string>',
                    ],
                    'VpcEndpointManagement' => 'CUSTOMER|SERVICE',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members
Pipeline
Type: Pipeline structure

Container for information about the updated pipeline.

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

ValidationException:

An exception for missing or invalid input fields.

InternalException:

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

AccessDeniedException:

You don't have permissions to access the resource.

ResourceNotFoundException:

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

ConflictException:

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

ValidatePipeline 

$result = $client->validatePipeline([/* ... */]);
$promise = $client->validatePipelineAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Members
PipelineConfigurationBody
Required: Yes
Type: string

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.

Result Syntax

[
    'Errors' => [
        [
            'Message' => '<string>',
        ],
        // ...
    ],
    'isValid' => true || false,
]

Result Details

Members
Errors
Type: Array of ValidationMessage structures

A list of errors if the configuration is invalid.

isValid
Type: boolean

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

Errors

DisabledOperationException:

Exception is thrown when an operation has been disabled.

AccessDeniedException:

You don't have permissions to access the resource.

InternalException:

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

ValidationException:

An exception for missing or invalid input fields.

Shapes

AccessDeniedException

Description

You don't have permissions to access the resource.

Members

BufferOptions

Description

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

Members
PersistentBufferEnabled
Required: Yes
Type: boolean

Whether persistent buffering should be enabled.

ChangeProgressStage

Description

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

Members
Description
Type: string

A description of the stage.

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

The most recent updated timestamp of the stage.

Name
Type: string

The name of the stage.

Status
Type: string

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

ChangeProgressStatus

Description

The progress details of a pipeline configuration change.

Members
ChangeProgressStages
Type: Array of ChangeProgressStage structures

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

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

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

Status
Type: string

The overall status of the pipeline configuration change.

TotalNumberOfStages
Type: int

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

CloudWatchLogDestination

Description

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.

Members
LogGroup
Required: Yes
Type: string

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/vendedlogs/OpenSearchService/pipelines.

ConflictException

Description

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

Members

DisabledOperationException

Description

Exception is thrown when an operation has been disabled.

Members

EncryptionAtRestOptions

Description

Options to control how OpenSearch encrypts buffer data.

Members
KmsKeyArn
Required: Yes
Type: string

The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.

InternalException

Description

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

Members

InvalidPaginationTokenException

Description

An invalid pagination token provided in the request.

Members

LimitExceededException

Description

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

Members

LogPublishingOptions

Description

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.

Members
CloudWatchLogDestination
Type: CloudWatchLogDestination structure

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

IsLoggingEnabled
Type: boolean

Whether logs should be published.

Pipeline

Description

Information about an existing OpenSearch Ingestion pipeline.

Members
BufferOptions
Type: BufferOptions structure

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

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

The date and time when the pipeline was created.

Destinations
Type: Array of PipelineDestination structures

Destinations to which the pipeline writes data.

EncryptionAtRestOptions
Type: EncryptionAtRestOptions structure

Options to control how OpenSearch encrypts buffer data.

IngestEndpointUrls
Type: Array of strings

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

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

The date and time when the pipeline was last updated.

LogPublishingOptions
Type: LogPublishingOptions structure

Key-value pairs that represent log publishing settings.

MaxUnits
Type: int

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

MinUnits
Type: int

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

PipelineArn
Type: string

The Amazon Resource Name (ARN) of the pipeline.

PipelineConfigurationBody
Type: string

The Data Prepper pipeline configuration in YAML format.

PipelineName
Type: string

The name of the pipeline.

ServiceVpcEndpoints
Type: Array of ServiceVpcEndpoint structures

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

Status
Type: string

The current status of the pipeline.

StatusReason
Type: PipelineStatusReason structure

The reason for the current status of the pipeline.

Tags
Type: Array of Tag structures

A list of tags associated with the given pipeline.

VpcEndpointService
Type: string

The VPC endpoint service name for the pipeline.

VpcEndpoints
Type: Array of VpcEndpoint structures

The VPC interface endpoints that have access to the pipeline.

PipelineBlueprint

Description

Container for information about an OpenSearch Ingestion blueprint.

Members
BlueprintName
Type: string

The name of the blueprint.

DisplayDescription
Type: string

A description of the blueprint.

DisplayName
Type: string

The display name of the blueprint.

PipelineConfigurationBody
Type: string

The YAML configuration of the blueprint.

Service
Type: string

The name of the service that the blueprint is associated with.

UseCase
Type: string

The use case that the blueprint relates to.

PipelineBlueprintSummary

Description

A summary of an OpenSearch Ingestion blueprint.

Members
BlueprintName
Type: string

The name of the blueprint.

DisplayDescription
Type: string

A description of the blueprint.

DisplayName
Type: string

The display name of the blueprint.

Service
Type: string

The name of the service that the blueprint is associated with.

UseCase
Type: string

The use case that the blueprint relates to.

PipelineDestination

Description

An object representing the destination of a pipeline.

Members
Endpoint
Type: string

The endpoint receiving data from the pipeline.

ServiceName
Type: string

The name of the service receiving data from the pipeline.

PipelineStatusReason

Description

Information about a pipeline's current status.

Members
Description
Type: string

A description of why a pipeline has a certain status.

PipelineSummary

Description

Summary information for an OpenSearch Ingestion pipeline.

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

The date and time when the pipeline was created.

Destinations
Type: Array of PipelineDestination structures

A list of destinations to which the pipeline writes data.

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

The date and time when the pipeline was last updated.

MaxUnits
Type: int

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

MinUnits
Type: int

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

PipelineArn
Type: string

The Amazon Resource Name (ARN) of the pipeline.

PipelineName
Type: string

The name of the pipeline.

Status
Type: string

The current status of the pipeline.

StatusReason
Type: PipelineStatusReason structure

Information about a pipeline's current status.

Tags
Type: Array of Tag structures

A list of tags associated with the given pipeline.

ResourceAlreadyExistsException

Description

You attempted to create a resource that already exists.

Members

ResourceNotFoundException

Description

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

Members

ServiceVpcEndpoint

Description

A container for information about VPC endpoints that were created to other services

Members
ServiceName
Type: string

The name of the service for which a VPC endpoint was created.

VpcEndpointId
Type: string

The unique identifier of the VPC endpoint that was created.

Tag

Description

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

Members
Key
Required: Yes
Type: string

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

Value
Required: Yes
Type: string

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

ValidationException

Description

An exception for missing or invalid input fields.

Members

ValidationMessage

Description

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

Members
Message
Type: string

The validation message.

VpcAttachmentOptions

Description

Options for attaching a VPC to pipeline.

Members
AttachToVpc
Required: Yes
Type: boolean

Whether a VPC is attached to the pipeline.

CidrBlock
Type: string

The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).

VpcEndpoint

Description

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

Members
VpcEndpointId
Type: string

The unique identifier of the endpoint.

VpcId
Type: string

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

VpcOptions
Type: VpcOptions structure

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

VpcOptions

Description

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

Members
SecurityGroupIds
Type: Array of strings

A list of security groups associated with the VPC endpoint.

SubnetIds
Required: Yes
Type: Array of strings

A list of subnet IDs associated with the VPC endpoint.

VpcAttachmentOptions
Type: VpcAttachmentOptions structure

Options for attaching a VPC to a pipeline.

VpcEndpointManagement
Type: string

Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.