AWS API Changes

2025/09/16 - Amazon OpenSearch Ingestion - 8 new api methods

Changes Adds support for cross-account ingestion for push-based sources. This includes resource policies for sharing pipelines across accounts and features for managing pipeline endpoints which enable accessing pipelines across different VPCs, including VPCs in other accounts.

CreatePipelineEndpoint (new)

Link ¶

Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to.

See also: AWS API Documentation

Request Syntax

client.create_pipeline_endpoint(
    PipelineArn='string',
    VpcOptions={
        'SubnetIds': [
            'string',
        ],
        'SecurityGroupIds': [
            'string',
        ]
    }
)

type PipelineArn:

string

param PipelineArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the pipeline to create the endpoint for.

type VpcOptions:

dict

param VpcOptions:

[REQUIRED]

Container for the VPC configuration for the pipeline endpoint, including subnet IDs and security group IDs.

SubnetIds (list) --

A list of subnet IDs where the pipeline endpoint network interfaces are created.
- (string) --
SecurityGroupIds (list) --

A list of security group IDs that control network access to the pipeline endpoint.
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'PipelineArn': 'string',
    'EndpointId': 'string',
    'Status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'REVOKING'|'REVOKED',
    'VpcId': 'string'
}

Response Structure

(dict) --
- PipelineArn (string) --
  
  The Amazon Resource Name (ARN) of the pipeline associated with the endpoint.
- EndpointId (string) --
  
  The unique identifier of the pipeline endpoint.
- Status (string) --
  
  The current status of the pipeline endpoint.
- VpcId (string) --
  
  The ID of the VPC where the pipeline endpoint was created.

ListPipelineEndpointConnections (new)

Link ¶

Lists the pipeline endpoints connected to pipelines in your account.

See also: AWS API Documentation

Request Syntax

client.list_pipeline_endpoint_connections(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of pipeline endpoint connections to return in the response.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'PipelineEndpointConnections': [
        {
            'PipelineArn': 'string',
            'EndpointId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'REVOKING'|'REVOKED',
            'VpcEndpointOwner': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (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.
- PipelineEndpointConnections (list) --
  
  A list of pipeline endpoint connections.
  - (dict) --
    
    Represents a connection to a pipeline endpoint, containing details about the endpoint association.
    - PipelineArn (string) --
      
      The Amazon Resource Name (ARN) of the pipeline in the endpoint connection.
    - EndpointId (string) --
      
      The unique identifier of the endpoint in the connection.
    - Status (string) --
      
      The current status of the pipeline endpoint connection.
    - VpcEndpointOwner (string) --
      
      The Amazon Web Services account ID that owns the VPC endpoint used in this connection.

GetResourcePolicy (new)

Link ¶

Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.

See also: AWS API Documentation

Request Syntax

client.get_resource_policy(
    ResourceArn='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource for which to retrieve the policy.

rtype:

dict

returns:

Response Syntax

{
    'ResourceArn': 'string',
    'Policy': 'string'
}

Response Structure

(dict) --
- ResourceArn (string) --
  
  The Amazon Resource Name (ARN) of the resource.
- Policy (string) --
  
  The resource-based policy document in JSON format.

ListPipelineEndpoints (new)

Link ¶

Lists all pipeline endpoints in your account.

See also: AWS API Documentation

Request Syntax

client.list_pipeline_endpoints(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of pipeline endpoints to return in the response.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'PipelineEndpoints': [
        {
            'PipelineArn': 'string',
            'EndpointId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'DELETING'|'REVOKING'|'REVOKED',
            'VpcId': 'string',
            'VpcOptions': {
                'SubnetIds': [
                    'string',
                ],
                'SecurityGroupIds': [
                    'string',
                ]
            },
            'IngestEndpointUrl': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (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.
- PipelineEndpoints (list) --
  
  A list of pipeline endpoints.
  - (dict) --
    
    Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.
    - PipelineArn (string) --
      
      The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.
    - EndpointId (string) --
      
      The unique identifier for the pipeline endpoint.
    - Status (string) --
      
      The current status of the pipeline endpoint.
    - VpcId (string) --
      
      The ID of the VPC where the pipeline endpoint is created.
    - VpcOptions (dict) --
      
      Configuration options for the VPC endpoint, including subnet and security group settings.
      - SubnetIds (list) --
        
        A list of subnet IDs where the pipeline endpoint network interfaces are created.
        
        (string) --
      - SecurityGroupIds (list) --
        
        A list of security group IDs that control network access to the pipeline endpoint.
        
        (string) --
    - IngestEndpointUrl (string) --
      
      The URL used to ingest data to the pipeline through the VPC endpoint.

PutResourcePolicy (new)

Link ¶

Attaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based policies grant permissions to principals to perform actions on the resource.

See also: AWS API Documentation

Request Syntax

client.put_resource_policy(
    ResourceArn='string',
    Policy='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to attach the policy to.

type Policy:

string

param Policy:

[REQUIRED]

The resource-based policy document in JSON format.

rtype:

dict

returns:

Response Syntax

{
    'ResourceArn': 'string',
    'Policy': 'string'
}

Response Structure

(dict) --
- ResourceArn (string) --
  
  The Amazon Resource Name (ARN) of the resource.
- Policy (string) --
  
  The resource-based policy document that was attached to the resource.

DeletePipelineEndpoint (new)

Link ¶

Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.

See also: AWS API Documentation

Request Syntax

client.delete_pipeline_endpoint(
    EndpointId='string'
)

type EndpointId:

string

param EndpointId:

[REQUIRED]

The unique identifier of the pipeline endpoint to delete.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

RevokePipelineEndpointConnections (new)

Link ¶

Revokes pipeline endpoints from specified endpoint IDs.

See also: AWS API Documentation

Request Syntax

client.revoke_pipeline_endpoint_connections(
    PipelineArn='string',
    EndpointIds=[
        'string',
    ]
)

type PipelineArn:

string

param PipelineArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint connections.

type EndpointIds:

list

param EndpointIds:

[REQUIRED]

A list of endpoint IDs for which to revoke access to the pipeline.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'PipelineArn': 'string'
}

Response Structure

(dict) --
- PipelineArn (string) --
  
  The Amazon Resource Name (ARN) of the pipeline from which endpoint connections were revoked.

DeleteResourcePolicy (new)

Link ¶

Deletes a resource-based policy from an OpenSearch Ingestion resource.

See also: AWS API Documentation

Request Syntax

client.delete_resource_policy(
    ResourceArn='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the resource from which to delete the policy.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --