Skip to content

describe_endpoints

Operation

describe_endpoints

describe_endpoints(request: DescribeEndpointsInput | DescribeEndpointsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeEndpointsInputDict]) -> DescribeEndpointsOutput

Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.

Parameters:

Name Type Description Default
request DescribeEndpointsInput | DescribeEndpointsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeEndpointsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeEndpointsOutput

An instance of DescribeEndpointsOutput.

describe_endpoints async

describe_endpoints(request: DescribeEndpointsInput | DescribeEndpointsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeEndpointsInputDict]) -> DescribeEndpointsOutput

Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.

Parameters:

Name Type Description Default
request DescribeEndpointsInput | DescribeEndpointsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeEndpointsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeEndpointsOutput

An instance of DescribeEndpointsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeEndpointsInputDict

Bases: TypedDict

Dictionary form of DescribeEndpointsInput.

DescribeEndpointsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeEndpointsInput structure.

Output

DescribeEndpointsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeEndpointsOutput structure.

Attributes

endpoints instance-attribute
endpoints: list[Endpoint]

List of endpoints.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.