AWS API Changes

2020/06/03 - Amazon Elasticsearch Service - 7 new api methods

Changes Update es client to latest version

DescribeOutboundCrossClusterSearchConnections (new)

Link ¶

Lists all the outbound cross-cluster search connections for a source domain.

Request Syntax

client.describe_outbound_cross_cluster_search_connections(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type Filters:

list

param Filters:

A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are:

cross-cluster-search-connection-id
destination-domain-info.domain-name
destination-domain-info.owner-id
destination-domain-info.region
source-domain-info.domain-name

(dict) --

A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
- Name (string) --
  
  Specifies the name of the filter.
- Values (list) --
  
  Contains one or more values for the filter.
  - (string) --

type MaxResults:

integer

param MaxResults:

Set this value to limit the number of results returned. If not specified, defaults to 100.

type NextToken:

string

param NextToken:

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

rtype:

dict

returns:

Response Syntax

{
    'CrossClusterSearchConnections': [
        {
            'SourceDomainInfo': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            },
            'DestinationDomainInfo': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            },
            'CrossClusterSearchConnectionId': 'string',
            'ConnectionAlias': 'string',
            'ConnectionStatus': {
                'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

The result of a DescribeOutboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.
- CrossClusterSearchConnections (list) --
  
  Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.
  - (dict) --
    
    Specifies details of an outbound connection.
    - SourceDomainInfo (dict) --
      
      Specifies the DomainInformation for the source Elasticsearch domain.
      - OwnerId (string) --
      - DomainName (string) --
        
        The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      - Region (string) --
    - DestinationDomainInfo (dict) --
      
      Specifies the DomainInformation for the destination Elasticsearch domain.
      - OwnerId (string) --
      - DomainName (string) --
        
        The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      - Region (string) --
    - CrossClusterSearchConnectionId (string) --
      
      Specifies the connection id for the outbound cross-cluster search connection.
    - ConnectionAlias (string) --
      
      Specifies the connection alias for the outbound cross-cluster search connection.
    - ConnectionStatus (dict) --
      
      Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.
      - StatusCode (string) --
        
        The state code for outbound connection. This 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 destination domain owner.
        
        PROVISIONING: Outbound connection request is in process.
        
        ACTIVE: Outbound connection is active and ready to use.
        
        REJECTED: Outbound connection request is rejected by destination domain owner.
        
        DELETING: Outbound connection deletion is in progress.
        
        DELETED: Outbound connection is deleted and cannot be used further.
      - Message (string) --
        
        Specifies verbose information for the outbound connection status.
- NextToken (string) --
  
  If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

DeleteInboundCrossClusterSearchConnection (new)

Link ¶

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

See also: AWS API Documentation

Request Syntax

client.delete_inbound_cross_cluster_search_connection(
    CrossClusterSearchConnectionId='string'
)

type CrossClusterSearchConnectionId:

string

param CrossClusterSearchConnectionId:

[REQUIRED]

The id of the inbound connection that you want to permanently delete.

rtype:

dict

returns:

Response Syntax

{
    'CrossClusterSearchConnection': {
        'SourceDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'DestinationDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'CrossClusterSearchConnectionId': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) --

The result of a DeleteInboundCrossClusterSearchConnection operation. Contains details of deleted inbound connection.
- CrossClusterSearchConnection (dict) --
  
  Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.
  - SourceDomainInfo (dict) --
    
    Specifies the DomainInformation for the source Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - DestinationDomainInfo (dict) --
    
    Specifies the DomainInformation for the destination Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - CrossClusterSearchConnectionId (string) --
    
    Specifies the connection id for the inbound cross-cluster search connection.
  - ConnectionStatus (dict) --
    
    Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.
    - StatusCode (string) --
      
      The state code for inbound connection. This can be one of the following:
      - PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
      - APPROVED: Inbound connection is pending acceptance by destination domain owner.
      - 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 cannot be used further.
    - Message (string) --
      
      Specifies verbose information for the inbound connection status.

DeleteOutboundCrossClusterSearchConnection (new)

Link ¶

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

See also: AWS API Documentation

Request Syntax

client.delete_outbound_cross_cluster_search_connection(
    CrossClusterSearchConnectionId='string'
)

type CrossClusterSearchConnectionId:

string

param CrossClusterSearchConnectionId:

[REQUIRED]

The id of the outbound connection that you want to permanently delete.

rtype:

dict

returns:

Response Syntax

{
    'CrossClusterSearchConnection': {
        'SourceDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'DestinationDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'CrossClusterSearchConnectionId': 'string',
        'ConnectionAlias': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) --

The result of a DeleteOutboundCrossClusterSearchConnection operation. Contains details of deleted outbound connection.
- CrossClusterSearchConnection (dict) --
  
  Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.
  - SourceDomainInfo (dict) --
    
    Specifies the DomainInformation for the source Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - DestinationDomainInfo (dict) --
    
    Specifies the DomainInformation for the destination Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - CrossClusterSearchConnectionId (string) --
    
    Specifies the connection id for the outbound cross-cluster search connection.
  - ConnectionAlias (string) --
    
    Specifies the connection alias for the outbound cross-cluster search connection.
  - ConnectionStatus (dict) --
    
    Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.
    - StatusCode (string) --
      
      The state code for outbound connection. This 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 destination domain owner.
      - PROVISIONING: Outbound connection request is in process.
      - ACTIVE: Outbound connection is active and ready to use.
      - REJECTED: Outbound connection request is rejected by destination domain owner.
      - DELETING: Outbound connection deletion is in progress.
      - DELETED: Outbound connection is deleted and cannot be used further.
    - Message (string) --
      
      Specifies verbose information for the outbound connection status.

CreateOutboundCrossClusterSearchConnection (new)

Link ¶

Creates a new cross-cluster search connection from a source domain to a destination domain.

See also: AWS API Documentation

Request Syntax

client.create_outbound_cross_cluster_search_connection(
    SourceDomainInfo={
        'OwnerId': 'string',
        'DomainName': 'string',
        'Region': 'string'
    },
    DestinationDomainInfo={
        'OwnerId': 'string',
        'DomainName': 'string',
        'Region': 'string'
    },
    ConnectionAlias='string'
)

type SourceDomainInfo:

dict

param SourceDomainInfo:

[REQUIRED]

Specifies the DomainInformation for the source Elasticsearch domain.

OwnerId (string) --
DomainName (string) -- [REQUIRED]

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Region (string) --

type DestinationDomainInfo:

dict

param DestinationDomainInfo:

[REQUIRED]

Specifies the DomainInformation for the destination Elasticsearch domain.

OwnerId (string) --
DomainName (string) -- [REQUIRED]

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
Region (string) --

type ConnectionAlias:

string

param ConnectionAlias:

[REQUIRED]

Specifies the connection alias that will be used by the customer for this connection.

rtype:

dict

returns:

Response Syntax

{
    'SourceDomainInfo': {
        'OwnerId': 'string',
        'DomainName': 'string',
        'Region': 'string'
    },
    'DestinationDomainInfo': {
        'OwnerId': 'string',
        'DomainName': 'string',
        'Region': 'string'
    },
    'ConnectionAlias': 'string',
    'ConnectionStatus': {
        'StatusCode': 'PENDING_ACCEPTANCE'|'VALIDATING'|'VALIDATION_FAILED'|'PROVISIONING'|'ACTIVE'|'REJECTED'|'DELETING'|'DELETED',
        'Message': 'string'
    },
    'CrossClusterSearchConnectionId': 'string'
}

Response Structure

(dict) --

The result of a CreateOutboundCrossClusterSearchConnection request. Contains the details of the newly created cross-cluster search connection.
- SourceDomainInfo (dict) --
  
  Specifies the DomainInformation for the source Elasticsearch domain.
  - OwnerId (string) --
  - DomainName (string) --
    
    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  - Region (string) --
- DestinationDomainInfo (dict) --
  
  Specifies the DomainInformation for the destination Elasticsearch domain.
  - OwnerId (string) --
  - DomainName (string) --
    
    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  - Region (string) --
- ConnectionAlias (string) --
  
  Specifies the connection alias provided during the create connection request.
- ConnectionStatus (dict) --
  
  Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.
  - StatusCode (string) --
    
    The state code for outbound connection. This 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 destination domain owner.
    - PROVISIONING: Outbound connection request is in process.
    - ACTIVE: Outbound connection is active and ready to use.
    - REJECTED: Outbound connection request is rejected by destination domain owner.
    - DELETING: Outbound connection deletion is in progress.
    - DELETED: Outbound connection is deleted and cannot be used further.
  - Message (string) --
    
    Specifies verbose information for the outbound connection status.
- CrossClusterSearchConnectionId (string) --
  
  Unique id for the created outbound connection, which is used for subsequent operations on connection.

DescribeInboundCrossClusterSearchConnections (new)

Link ¶

Lists all the inbound cross-cluster search connections for a destination domain.

See also: AWS API Documentation

Request Syntax

client.describe_inbound_cross_cluster_search_connections(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type Filters:

list

param Filters:

A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are:

cross-cluster-search-connection-id
source-domain-info.domain-name
source-domain-info.owner-id
source-domain-info.region
destination-domain-info.domain-name

(dict) --

A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
- Name (string) --
  
  Specifies the name of the filter.
- Values (list) --
  
  Contains one or more values for the filter.
  - (string) --

type MaxResults:

integer

param MaxResults:

Set this value to limit the number of results returned. If not specified, defaults to 100.

type NextToken:

string

param NextToken:

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

rtype:

dict

returns:

Response Syntax

{
    'CrossClusterSearchConnections': [
        {
            'SourceDomainInfo': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            },
            'DestinationDomainInfo': {
                'OwnerId': 'string',
                'DomainName': 'string',
                'Region': 'string'
            },
            'CrossClusterSearchConnectionId': 'string',
            'ConnectionStatus': {
                'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
                'Message': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

The result of a DescribeInboundCrossClusterSearchConnections request. Contains the list of connections matching the filter criteria.
- CrossClusterSearchConnections (list) --
  
  Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.
  - (dict) --
    
    Specifies details of an inbound connection.
    - SourceDomainInfo (dict) --
      
      Specifies the DomainInformation for the source Elasticsearch domain.
      - OwnerId (string) --
      - DomainName (string) --
        
        The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      - Region (string) --
    - DestinationDomainInfo (dict) --
      
      Specifies the DomainInformation for the destination Elasticsearch domain.
      - OwnerId (string) --
      - DomainName (string) --
        
        The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
      - Region (string) --
    - CrossClusterSearchConnectionId (string) --
      
      Specifies the connection id for the inbound cross-cluster search connection.
    - ConnectionStatus (dict) --
      
      Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.
      - StatusCode (string) --
        
        The state code for inbound connection. This can be one of the following:
        
        PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
        
        APPROVED: Inbound connection is pending acceptance by destination domain owner.
        
        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 cannot be used further.
      - Message (string) --
        
        Specifies verbose information for the inbound connection status.
- NextToken (string) --
  
  If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

AcceptInboundCrossClusterSearchConnection (new)

Link ¶

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

See also: AWS API Documentation

Request Syntax

client.accept_inbound_cross_cluster_search_connection(
    CrossClusterSearchConnectionId='string'
)

type CrossClusterSearchConnectionId:

string

param CrossClusterSearchConnectionId:

[REQUIRED]

The id of the inbound connection that you want to accept.

rtype:

dict

returns:

Response Syntax

{
    'CrossClusterSearchConnection': {
        'SourceDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'DestinationDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'CrossClusterSearchConnectionId': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) --

The result of a AcceptInboundCrossClusterSearchConnection operation. Contains details of accepted inbound connection.
- CrossClusterSearchConnection (dict) --
  
  Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.
  - SourceDomainInfo (dict) --
    
    Specifies the DomainInformation for the source Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - DestinationDomainInfo (dict) --
    
    Specifies the DomainInformation for the destination Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - CrossClusterSearchConnectionId (string) --
    
    Specifies the connection id for the inbound cross-cluster search connection.
  - ConnectionStatus (dict) --
    
    Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.
    - StatusCode (string) --
      
      The state code for inbound connection. This can be one of the following:
      - PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
      - APPROVED: Inbound connection is pending acceptance by destination domain owner.
      - 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 cannot be used further.
    - Message (string) --
      
      Specifies verbose information for the inbound connection status.

RejectInboundCrossClusterSearchConnection (new)

Link ¶

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

See also: AWS API Documentation

Request Syntax

client.reject_inbound_cross_cluster_search_connection(
    CrossClusterSearchConnectionId='string'
)

type CrossClusterSearchConnectionId:

string

param CrossClusterSearchConnectionId:

[REQUIRED]

The id of the inbound connection that you want to reject.

rtype:

dict

returns:

Response Syntax

{
    'CrossClusterSearchConnection': {
        'SourceDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'DestinationDomainInfo': {
            'OwnerId': 'string',
            'DomainName': 'string',
            'Region': 'string'
        },
        'CrossClusterSearchConnectionId': 'string',
        'ConnectionStatus': {
            'StatusCode': 'PENDING_ACCEPTANCE'|'APPROVED'|'REJECTING'|'REJECTED'|'DELETING'|'DELETED',
            'Message': 'string'
        }
    }
}

Response Structure

(dict) --

The result of a RejectInboundCrossClusterSearchConnection operation. Contains details of rejected inbound connection.
- CrossClusterSearchConnection (dict) --
  
  Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.
  - SourceDomainInfo (dict) --
    
    Specifies the DomainInformation for the source Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - DestinationDomainInfo (dict) --
    
    Specifies the DomainInformation for the destination Elasticsearch domain.
    - OwnerId (string) --
    - DomainName (string) --
      
      The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
    - Region (string) --
  - CrossClusterSearchConnectionId (string) --
    
    Specifies the connection id for the inbound cross-cluster search connection.
  - ConnectionStatus (dict) --
    
    Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.
    - StatusCode (string) --
      
      The state code for inbound connection. This can be one of the following:
      - PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
      - APPROVED: Inbound connection is pending acceptance by destination domain owner.
      - 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 cannot be used further.
    - Message (string) --
      
      Specifies verbose information for the inbound connection status.