2023/01/31 - Amazon OpenSearch Service - 7 updated api methods
Changes Amazon OpenSearch Service adds the option for a VPC endpoint connection between two domains when the local domain uses OpenSearch version 1.3 or 2.3. You can now use remote reindex to copy indices from one VPC domain to another without a reverse proxy.
{'Connection': {'ConnectionMode': 'DIRECT | VPC_ENDPOINT'}}
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.accept_inbound_connection(
ConnectionId='string'
)
string
[REQUIRED]
The ID of the inbound connection to accept.
dict
Response Syntax
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
}
}
Response Structure
(dict) --
Contains details about the accepted inbound connection.
Connection (dict) --
Information about the accepted inbound connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
The unique identifier of the connection.
ConnectionStatus (dict) --
The current status of the connection.
StatusCode (string) --
The status code for the connection. Can be one of the following:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
Message (string) --
Information about the connection.
ConnectionMode (string) --
The connection mode.
{'ConnectionMode': 'DIRECT | VPC_ENDPOINT'}
Response {'ConnectionMode': 'DIRECT | VPC_ENDPOINT',
'ConnectionProperties': {'Endpoint': 'string'}}
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.create_outbound_connection(
LocalDomainInfo={
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
RemoteDomainInfo={
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
ConnectionAlias='string',
ConnectionMode='DIRECT'|'VPC_ENDPOINT'
)
dict
[REQUIRED]
Name and Region of the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) -- [REQUIRED]
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
dict
[REQUIRED]
Name and Region of the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) -- [REQUIRED]
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
string
[REQUIRED]
Name of the connection.
string
The connection mode.
dict
Response Syntax
{
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionId': 'string',
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
'ConnectionProperties': {
'Endpoint': 'string'
}
}
Response Structure
(dict) --
The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionAlias (string) --
Name of the connection.
ConnectionStatus (dict) --
The status of the connection.
StatusCode (string) --
The status code for the outbound connection. Can be one of the following:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
Message (string) --
Verbose information for the outbound connection.
ConnectionId (string) --
The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
ConnectionMode (string) --
The connection mode.
ConnectionProperties (dict) --
The ConnectionProperties for the newly created connection.
Endpoint (string) --
The endpoint of the remote domain.
{'Connection': {'ConnectionMode': 'DIRECT | VPC_ENDPOINT'}}
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.delete_inbound_connection(
ConnectionId='string'
)
string
[REQUIRED]
The ID of the inbound connection to permanently delete.
dict
Response Syntax
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
}
}
Response Structure
(dict) --
The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
Connection (dict) --
The deleted inbound connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
The unique identifier of the connection.
ConnectionStatus (dict) --
The current status of the connection.
StatusCode (string) --
The status code for the connection. Can be one of the following:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
Message (string) --
Information about the connection.
ConnectionMode (string) --
The connection mode.
{'Connection': {'ConnectionMode': 'DIRECT | VPC_ENDPOINT',
'ConnectionProperties': {'Endpoint': 'string'}}}
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.delete_outbound_connection(
ConnectionId='string'
)
string
[REQUIRED]
The ID of the outbound connection you want to permanently delete.
dict
Response Syntax
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
'ConnectionProperties': {
'Endpoint': 'string'
}
}
}
Response Structure
(dict) --
Details about the deleted outbound connection.
Connection (dict) --
The deleted inbound connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
Unique identifier of the connection.
ConnectionAlias (string) --
Name of the connection.
ConnectionStatus (dict) --
Status of the connection.
StatusCode (string) --
The status code for the outbound connection. Can be one of the following:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
Message (string) --
Verbose information for the outbound connection.
ConnectionMode (string) --
The connection mode.
ConnectionProperties (dict) --
Properties for the outbound connection.
Endpoint (string) --
The endpoint of the remote domain.
{'Connections': {'ConnectionMode': 'DIRECT | VPC_ENDPOINT'}}
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.describe_inbound_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
A list of filters used to match properties for inbound cross-cluster connections.
(dict) --
A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
Name (string) --
The name of the filter.
Values (list) --
One or more values for the filter.
(string) --
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
string
If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.
dict
Response Syntax
{
'Connections': [
{
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains a list of connections matching the filter criteria.
Connections (list) --
List of inbound connections.
(dict) --
Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
The unique identifier of the connection.
ConnectionStatus (dict) --
The current status of the connection.
StatusCode (string) --
The status code for the connection. Can be one of the following:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
Message (string) --
Information about the connection.
ConnectionMode (string) --
The connection mode.
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.
{'Connections': {'ConnectionMode': 'DIRECT | VPC_ENDPOINT',
'ConnectionProperties': {'Endpoint': 'string'}}}
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
client.describe_outbound_connections(
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
List of filter names and values that you can use for requests.
(dict) --
A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.
Name (string) --
The name of the filter.
Values (list) --
One or more values for the filter.
(string) --
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
string
If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.
dict
Response Syntax
{
'Connections': [
{
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionAlias': 'string',
'ConnectionStatus': {
'StatusCode': 'VALIDATING'|'VALIDATION_FAILED'|'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT',
'ConnectionProperties': {
'Endpoint': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains a list of connections matching the filter criteria.
Connections (list) --
List of outbound connections that match the filter criteria.
(dict) --
Specifies details about an outbound cross-cluster connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
Unique identifier of the connection.
ConnectionAlias (string) --
Name of the connection.
ConnectionStatus (dict) --
Status of the connection.
StatusCode (string) --
The status code for the outbound connection. Can be one of the following:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
Message (string) --
Verbose information for the outbound connection.
ConnectionMode (string) --
The connection mode.
ConnectionProperties (dict) --
Properties for the outbound connection.
Endpoint (string) --
The endpoint of the remote domain.
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.
{'Connection': {'ConnectionMode': 'DIRECT | VPC_ENDPOINT'}}
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
See also: AWS API Documentation
Request Syntax
client.reject_inbound_connection(
ConnectionId='string'
)
string
[REQUIRED]
The unique identifier of the inbound connection to reject.
dict
Response Syntax
{
'Connection': {
'LocalDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'RemoteDomainInfo': {
'AWSDomainInformation': {
'OwnerId': 'string',
'DomainName': 'string',
'Region': 'string'
}
},
'ConnectionId': 'string',
'ConnectionStatus': {
'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'PROVISIONING'|'ACTIVE'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
'Message': 'string'
},
'ConnectionMode': 'DIRECT'|'VPC_ENDPOINT'
}
}
Response Structure
(dict) --
Represents the output of a RejectInboundConnection operation.
Connection (dict) --
Contains details about the rejected inbound connection.
LocalDomainInfo (dict) --
Information about the source (local) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo (dict) --
Information about the destination (remote) domain.
AWSDomainInformation (dict) --
Information about an Amazon OpenSearch Service domain.
OwnerId (string) --
The Amazon Web Services account ID of the domain owner.
DomainName (string) --
Name of the domain.
Region (string) --
The Amazon Web Services Region in which the domain is located.
ConnectionId (string) --
The unique identifier of the connection.
ConnectionStatus (dict) --
The current status of the connection.
StatusCode (string) --
The status code for the connection. Can be one of the following:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
Message (string) --
Information about the connection.
ConnectionMode (string) --
The connection mode.