list_public_keys¶
Operation¶
list_public_keys
¶
list_public_keys(request: ListPublicKeysInput | ListPublicKeysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPublicKeysInputDict]) -> 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 |
|---|---|---|---|
request
|
ListPublicKeysInput | ListPublicKeysInputDict | 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[ListPublicKeysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListPublicKeysOutput
|
An instance of |
list_public_keys
async
¶
list_public_keys(request: ListPublicKeysInput | ListPublicKeysInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListPublicKeysInputDict]) -> 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 |
|---|---|---|---|
request
|
ListPublicKeysInput | ListPublicKeysInputDict | 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[ListPublicKeysInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListPublicKeysOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListPublicKeysInputDict
¶
ListPublicKeysInput
dataclass
¶
Bases: _SerdeShape
Requests the public keys for a specified time range.
Attributes¶
end_time
class-attribute
instance-attribute
¶
end_time: datetime | 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.
Output¶
ListPublicKeysOutput
dataclass
¶
Bases: _SerdeShape
Returns the objects or data listed below if successful. Otherwise, returns an error.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
Reserved for future use.
public_key_list
class-attribute
instance-attribute
¶
Contains an array of PublicKey objects.
Note
The returned public keys may have validity time ranges that overlap.
response_metadata
class-attribute
instance-attribute
¶
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.