get_sdk_types

APIGateway.Client.get_sdk_types(**kwargs)

Gets SDK types

See also: AWS API Documentation

Request Syntax

response = client.get_sdk_types(
    position='string',
    limit=123
)

Parameters

• position (string) -- The current pagination position in the paged result set.
• limit (integer) -- The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  The collection of SdkType instances.

  • position (string) --

  • items (list) --

    The current page of elements from this collection.

    • (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