Skip to content

ACM  >  Operations  >  list_acme_endpoints

list_acme_endpoints

Operation

list_acme_endpoints async

list_acme_endpoints(request: ListAcmeEndpointsInput | ListAcmeEndpointsInputDict, /, *, plugins: list[Plugin] | None = None) -> ListAcmeEndpointsOutput
list_acme_endpoints(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAcmeEndpointsInputDict]) -> ListAcmeEndpointsOutput

Retrieves a list of ACME endpoints in your account. Use this operation to view all configured ACME endpoints and their current status.

Parameters:

Name Type Description Default
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

Returns:

Type Description
ListAcmeEndpointsOutput

An instance of ListAcmeEndpointsOutput.

Input

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

Model

ListAcmeEndpointsInput dataclass

Bases: _SerdeShape

Dataclass for ListAcmeEndpointsInput structure.

Attributes
max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return.

next_token class-attribute instance-attribute
next_token: str | None = ...

A token for pagination.

Dictionaries

ListAcmeEndpointsInputDict

Bases: TypedDict

Dictionary form of ListAcmeEndpointsInput.

Attributes
max_results instance-attribute
max_results: int | None

The maximum number of results to return.

next_token instance-attribute
next_token: str | None

A token for pagination.

Output

ListAcmeEndpointsOutput dataclass

Bases: _SerdeShape

Dataclass for ListAcmeEndpointsOutput structure.

Attributes

acme_endpoints class-attribute instance-attribute
acme_endpoints: list[AcmeEndpointSummary] | None = ...

The list of ACME endpoints.

next_token class-attribute instance-attribute
next_token: str | None = ...

A token for pagination.

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.