Skip to content

get_token_vault

Operation

get_token_vault

get_token_vault(request: GetTokenVaultInput | GetTokenVaultInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTokenVaultInputDict]) -> GetTokenVaultOutput

Retrieves information about a token vault.

Parameters:

Name Type Description Default
request GetTokenVaultInput | GetTokenVaultInputDict | 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[GetTokenVaultInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTokenVaultOutput

An instance of GetTokenVaultOutput.

get_token_vault async

get_token_vault(request: GetTokenVaultInput | GetTokenVaultInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTokenVaultInputDict]) -> GetTokenVaultOutput

Retrieves information about a token vault.

Parameters:

Name Type Description Default
request GetTokenVaultInput | GetTokenVaultInputDict | 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[GetTokenVaultInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTokenVaultOutput

An instance of GetTokenVaultOutput.

Input

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

GetTokenVaultInputDict

Bases: TypedDict

Dictionary form of GetTokenVaultInput.

Attributes

token_vault_id instance-attribute
token_vault_id: str | None

The unique identifier of the token vault to retrieve.

GetTokenVaultInput dataclass

Bases: _SerdeShape

Dataclass for GetTokenVaultInput structure.

Attributes

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

The unique identifier of the token vault to retrieve.

Output

GetTokenVaultOutput dataclass

Bases: _SerdeShape

Dataclass for GetTokenVaultOutput structure.

Attributes

kms_configuration instance-attribute
kms_configuration: KmsConfiguration

The KMS configuration for the token vault.

last_modified_date instance-attribute
last_modified_date: datetime

The timestamp when the token vault was last modified.

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.

token_vault_id instance-attribute
token_vault_id: str

The ID of the token vault.