OpenSearchServiceServerless / Client / batch_get_vpc_endpoint

batch_get_vpc_endpoint#

OpenSearchServiceServerless.Client.batch_get_vpc_endpoint(**kwargs)#

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Request Syntax

response = client.batch_get_vpc_endpoint(
    ids=[
        'string',
    ]
)

Parameters:

ids (list) –

[REQUIRED]

A list of VPC endpoint identifiers.

(string) –

Return type:

dict

Returns:

Response Syntax

{
    'vpcEndpointDetails': [
        {
            'createdDate': 123,
            'failureCode': 'string',
            'failureMessage': 'string',
            'id': 'string',
            'name': 'string',
            'securityGroupIds': [
                'string',
            ],
            'status': 'PENDING'|'DELETING'|'ACTIVE'|'FAILED',
            'subnetIds': [
                'string',
            ],
            'vpcId': 'string'
        },
    ],
    'vpcEndpointErrorDetails': [
        {
            'errorCode': 'string',
            'errorMessage': 'string',
            'id': 'string'
        },
    ]
}

Response Structure

(dict) –
- vpcEndpointDetails (list) –
  
  Details about the specified VPC endpoint.
  - (dict) –
    
    Details about an OpenSearch Serverless-managed interface endpoint.
    - createdDate (integer) –
      
      The date the endpoint was created.
    - failureCode (string) –
      
      A failure code associated with the request.
    - failureMessage (string) –
      
      A message associated with the failure code.
    - id (string) –
      
      The unique identifier of the endpoint.
    - name (string) –
      
      The name of the endpoint.
    - securityGroupIds (list) –
      
      The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
      - (string) –
    - status (string) –
      
      The current status of the endpoint.
    - subnetIds (list) –
      
      The ID of the subnets from which you access OpenSearch Serverless.
      - (string) –
    - vpcId (string) –
      
      The ID of the VPC from which you access OpenSearch Serverless.
- vpcEndpointErrorDetails (list) –
  
  Error information for a failed request.
  - (dict) –
    
    Error information for a failed BatchGetVpcEndpoint request.
    - errorCode (string) –
      
      The error code for the failed request.
    - errorMessage (string) –
      
      An error message describing the reason for the failure.
    - id (string) –
      
      The unique identifier of the VPC endpoint.

Exceptions

OpenSearchServiceServerless.Client.exceptions.InternalServerException
OpenSearchServiceServerless.Client.exceptions.ValidationException