APIGateway / Client / get_sdk_type

get_sdk_type#

APIGateway.Client.get_sdk_type(**kwargs)#

Gets an SDK type.

See also: AWS API Documentation

Request Syntax

response = client.get_sdk_type(
    id='string'
)
Parameters:

id (string) –

[REQUIRED]

The identifier of the queried SdkType instance.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'friendlyName': 'string',
    'description': 'string',
    'configurationProperties': [
        {
            'name': 'string',
            'friendlyName': 'string',
            'description': 'string',
            'required': True|False,
            'defaultValue': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    A type of SDK that API Gateway can generate.

    • id (string) –

      The identifier of an SdkType instance.

    • friendlyName (string) –

      The user-friendly name of an SdkType instance.

    • description (string) –

      The description of an SdkType.

    • configurationProperties (list) –

      A list of configuration properties of an SdkType.

      • (dict) –

        A configuration property of an SDK type.

        • name (string) –

          The name of a an SdkType configuration property.

        • friendlyName (string) –

          The user-friendly name of an SdkType configuration property.

        • description (string) –

          The description of an SdkType configuration property.

        • required (boolean) –

          A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required ( true) or not ( false).

        • defaultValue (string) –

          The default value of an SdkType configuration property.

Exceptions

  • APIGateway.Client.exceptions.BadRequestException

  • APIGateway.Client.exceptions.NotFoundException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException