:doc:`OpenSearchService <../../opensearch>` / Client / authorize_vpc_endpoint_access

*****************************
authorize_vpc_endpoint_access
*****************************



.. py:method:: OpenSearchService.Client.authorize_vpc_endpoint_access(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccess>`_  


  **Request Syntax**
  ::

    response = client.authorize_vpc_endpoint_access(
        DomainName='string',
        Account='string',
        Service='application.opensearchservice.amazonaws.com'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The name of the OpenSearch Service domain to provide access to.

    

  
  :type Account: string
  :param Account: 

    The Amazon Web Services account ID to grant access to.

    

  
  :type Service: string
  :param Service: 

    The Amazon Web Services service SP to grant access to.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'AuthorizedPrincipal': {
              'PrincipalType': 'AWS_ACCOUNT'|'AWS_SERVICE',
              'Principal': '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 <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html>`__ that is allowed access to the domain.

          
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.DisabledOperationException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.LimitExceededException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.ValidationException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.InternalException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.BaseException`

  