Skip to content

get_public_key

Operation

get_public_key

get_public_key(request: GetPublicKeyInput | GetPublicKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPublicKeyInputDict]) -> GetPublicKeyOutput

Gets a public key.

Parameters:

Name Type Description Default
request GetPublicKeyInput | GetPublicKeyInputDict | 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[GetPublicKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPublicKeyOutput

An instance of GetPublicKeyOutput.

get_public_key async

get_public_key(request: GetPublicKeyInput | GetPublicKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetPublicKeyInputDict]) -> GetPublicKeyOutput

Gets a public key.

Parameters:

Name Type Description Default
request GetPublicKeyInput | GetPublicKeyInputDict | 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[GetPublicKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetPublicKeyOutput

An instance of GetPublicKeyOutput.

Input

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

GetPublicKeyInputDict

Bases: TypedDict

Dictionary form of GetPublicKeyInput.

Attributes

id instance-attribute

The identifier of the public key you are getting.

GetPublicKeyInput dataclass

Bases: _SerdeShape

Dataclass for GetPublicKeyInput structure.

Attributes

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

The identifier of the public key you are getting.

Output

GetPublicKeyOutput dataclass

Bases: _SerdeShape

Dataclass for GetPublicKeyOutput structure.

Attributes

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

The identifier for this version of the public key.

public_key class-attribute instance-attribute
public_key: PublicKey | None = ...

The public key.

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.