Skip to content

CloudTrail  >  Operations  >  list_public_keys

list_public_keys

Operation

list_public_keys async 

list_public_keys(input: ListPublicKeysInput, plugins: list[Plugin] | None = None) -> ListPublicKeysOutput

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

Note

CloudTrail uses different private and public key pairs per Region. Each digest file is signed with a private key unique to its Region. When you validate a digest file from a specific Region, you must look in the same Region for its corresponding public key.

Parameters:

Name Type Description Default
input ListPublicKeysInput

An instance of ListPublicKeysInput.

 required
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
ListPublicKeysOutput

An instance of ListPublicKeysOutput.

Input

ListPublicKeysInput dataclass

Requests the public keys for a specified time range.

Attributes

end_time class-attribute instance-attribute 
end_time: datetime | None = None

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

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

Reserved for future use.

start_time class-attribute instance-attribute 
start_time: datetime | None = None

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

Output

ListPublicKeysOutput dataclass

Returns the objects or data listed below if successful. Otherwise, returns an error.

Attributes

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

Reserved for future use.

public_key_list class-attribute instance-attribute 
public_key_list: list[PublicKey] | None = None

Contains an array of PublicKey objects.

Note

The returned public keys may have validity time ranges that overlap.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.