OpenSearchService / Client / authorize_vpc_endpoint_access

authorize_vpc_endpoint_access¶

OpenSearchService.Client.authorize_vpc_endpoint_access(**kwargs)¶

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Request Syntax

response = client.authorize_vpc_endpoint_access(
    DomainName='string',
    Account='string',
    Service='application.opensearchservice.amazonaws.com',
    ServiceOptions={
        'SupportedRegions': [
            'string',
        ]
    }
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the OpenSearch Service domain to provide access to.
Account (string) – The Amazon Web Services account ID to grant access to.
Service (string) – The Amazon Web Services service SP to grant access to.
ServiceOptions (dict) –
The options for the service, including the supported Regions for the endpoint access.
- SupportedRegions (list) –
  
  The list of supported Regions for the service.
  - (string) –
    
    An Amazon Web Services Region, such as us-east-1.

Return type:

dict

Returns:

Response Syntax

{
    'AuthorizedPrincipal': {
        'PrincipalType': 'AWS_ACCOUNT'|'AWS_SERVICE',
        'Principal': 'string',
        'ServiceOptions': {
            'SupportedRegions': [
                'string',
            ]
        }
    }
}

Response Structure

(dict) –
- AuthorizedPrincipal (dict) –
  
  Information about the Amazon Web Services account or service that was provided access to the domain.
  - PrincipalType (string) –
    
    The type of principal.
  - Principal (string) –
    
    The IAM principal that is allowed access to the domain.
  - ServiceOptions (dict) –
    
    The options for the service, including the supported Regions for the endpoint access.
    - SupportedRegions (list) –
      
      The list of supported Regions for the service.
      - (string) –
        
        An Amazon Web Services Region, such as us-east-1.

Exceptions

OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.DisabledOperationException
OpenSearchService.Client.exceptions.LimitExceededException
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.BaseException