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.

See also: AWS API Documentation

Request Syntax

response = client.authorize_vpc_endpoint_access(
    DomainName='string',
    Account='string',
    Service='application.opensearchservice.amazonaws.com'
)
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.

Return type:

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 that is allowed access to the domain.

Exceptions