sdk_types

Creates, updates, deletes, gets or lists a sdk_types resource.

Overview

Name	sdk_types
Type	Resource
Id	aws.apigateway.sdk_types

Fields

The following fields are returned by SELECT queries:

get_sdk_type

Name	Datatype	Description
id	string	The identifier of an SdkType instance.
configuration_properties	array	A list of configuration properties of an SdkType.
description	string	The description of an SdkType.
friendly_name	string	The user-friendly name of an SdkType instance.

get_sdk_types

Name	Datatype	Description
id	string	The identifier of an SdkType instance.
configuration_properties	array	A list of configuration properties of an SdkType.
description	string	The description of an SdkType.
friendly_name	string	The user-friendly name of an SdkType instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sdk_type	select	sdktype_id, region		Gets an SDK type.
get_sdk_types	select	region	position, limit	Gets SDK types

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
sdktype_id	string	The identifier of the queried SdkType instance.
limit	integer	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
position	string	The current pagination position in the paged result set.

SELECT examples

get_sdk_type

Gets an SDK type.

SELECT
id,
configuration_properties,
description,
friendly_name
FROM aws.apigateway.sdk_types
WHERE sdktype_id = '{{ sdktype_id }}' -- required
AND region = '{{ region }}' -- required
;

get_sdk_types

Gets SDK types

SELECT
id,
configuration_properties,
description,
friendly_name
FROM aws.apigateway.sdk_types
WHERE region = '{{ region }}' -- required
AND position = '{{ position }}'
AND limit = '{{ limit }}'
;