Skip to content

get_sdk_type

Operation

get_sdk_type

get_sdk_type(request: GetSdkTypeInput | GetSdkTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSdkTypeInputDict]) -> GetSdkTypeOutput

Gets an SDK type.

Parameters:

Name Type Description Default
request GetSdkTypeInput | GetSdkTypeInputDict | 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[GetSdkTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSdkTypeOutput

An instance of GetSdkTypeOutput.

get_sdk_type async

get_sdk_type(request: GetSdkTypeInput | GetSdkTypeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSdkTypeInputDict]) -> GetSdkTypeOutput

Gets an SDK type.

Parameters:

Name Type Description Default
request GetSdkTypeInput | GetSdkTypeInputDict | 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[GetSdkTypeInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSdkTypeOutput

An instance of GetSdkTypeOutput.

Input

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

GetSdkTypeInputDict

Bases: TypedDict

Dictionary form of GetSdkTypeInput.

Attributes

id instance-attribute

The identifier of the queried SdkType instance.

GetSdkTypeInput dataclass

Bases: _SerdeShape

Get an SdkType instance.

Attributes

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

The identifier of the queried SdkType instance.

Output

GetSdkTypeOutput dataclass

Bases: _SerdeShape

A type of SDK that API Gateway can generate.

Attributes

configuration_properties class-attribute instance-attribute
configuration_properties: list[SdkConfigurationProperty] | None = ...

A list of configuration properties of an SdkType.

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

The description of an SdkType.

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

The user-friendly name of an SdkType instance.

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

The identifier of an SdkType instance.

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.