Skip to content

get_field_level_encryption

Operation

get_field_level_encryption

get_field_level_encryption(request: GetFieldLevelEncryptionInput | GetFieldLevelEncryptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFieldLevelEncryptionInputDict]) -> GetFieldLevelEncryptionOutput

Get the field-level encryption configuration information.

Parameters:

Name Type Description Default
request GetFieldLevelEncryptionInput | GetFieldLevelEncryptionInputDict | 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[GetFieldLevelEncryptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFieldLevelEncryptionOutput

An instance of GetFieldLevelEncryptionOutput.

get_field_level_encryption async

get_field_level_encryption(request: GetFieldLevelEncryptionInput | GetFieldLevelEncryptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFieldLevelEncryptionInputDict]) -> GetFieldLevelEncryptionOutput

Get the field-level encryption configuration information.

Parameters:

Name Type Description Default
request GetFieldLevelEncryptionInput | GetFieldLevelEncryptionInputDict | 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[GetFieldLevelEncryptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFieldLevelEncryptionOutput

An instance of GetFieldLevelEncryptionOutput.

Input

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

GetFieldLevelEncryptionInputDict

Bases: TypedDict

Dictionary form of GetFieldLevelEncryptionInput.

Attributes

id instance-attribute

Request the ID for the field-level encryption configuration information.

GetFieldLevelEncryptionInput dataclass

Bases: _SerdeShape

Dataclass for GetFieldLevelEncryptionInput structure.

Attributes

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

Request the ID for the field-level encryption configuration information.

Output

GetFieldLevelEncryptionOutput dataclass

Bases: _SerdeShape

Dataclass for GetFieldLevelEncryptionOutput structure.

Attributes

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

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

field_level_encryption class-attribute instance-attribute
field_level_encryption: FieldLevelEncryption | None = ...

Return the field-level encryption configuration information.

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.