1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. getThingType

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.iot.getThingType

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource Type definition for AWS::IoT::ThingType

Using getThingType

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getThingType(args: GetThingTypeArgs, opts?: InvokeOptions): Promise<GetThingTypeResult>
function getThingTypeOutput(args: GetThingTypeOutputArgs, opts?: InvokeOptions): Output<GetThingTypeResult>
Copy
def get_thing_type(thing_type_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetThingTypeResult
def get_thing_type_output(thing_type_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetThingTypeResult]
Copy
func LookupThingType(ctx *Context, args *LookupThingTypeArgs, opts ...InvokeOption) (*LookupThingTypeResult, error)
func LookupThingTypeOutput(ctx *Context, args *LookupThingTypeOutputArgs, opts ...InvokeOption) LookupThingTypeResultOutput
Copy

> Note: This function is named LookupThingType in the Go SDK.

public static class GetThingType 
{
    public static Task<GetThingTypeResult> InvokeAsync(GetThingTypeArgs args, InvokeOptions? opts = null)
    public static Output<GetThingTypeResult> Invoke(GetThingTypeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetThingTypeResult> getThingType(GetThingTypeArgs args, InvokeOptions options)
public static Output<GetThingTypeResult> getThingType(GetThingTypeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:iot:getThingType
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ThingTypeName This property is required. string
The name of the thing type.
ThingTypeName This property is required. string
The name of the thing type.
thingTypeName This property is required. String
The name of the thing type.
thingTypeName This property is required. string
The name of the thing type.
thing_type_name This property is required. str
The name of the thing type.
thingTypeName This property is required. String
The name of the thing type.

getThingType Result

The following output properties are available:

Arn string
The thing type arn.
DeprecateThingType bool

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

Id string
The thing type id.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
ThingTypeProperties Pulumi.AwsNative.IoT.Outputs.ThingTypePropertiesProperties
The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
Arn string
The thing type arn.
DeprecateThingType bool

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

Id string
The thing type id.
Tags Tag
An array of key-value pairs to apply to this resource.
ThingTypeProperties ThingTypePropertiesProperties
The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
arn String
The thing type arn.
deprecateThingType Boolean

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

id String
The thing type id.
tags List<Tag>
An array of key-value pairs to apply to this resource.
thingTypeProperties ThingTypePropertiesProperties
The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
arn string
The thing type arn.
deprecateThingType boolean

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

id string
The thing type id.
tags Tag[]
An array of key-value pairs to apply to this resource.
thingTypeProperties ThingTypePropertiesProperties
The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
arn str
The thing type arn.
deprecate_thing_type bool

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

id str
The thing type id.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
thing_type_properties ThingTypePropertiesProperties
The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .
arn String
The thing type arn.
deprecateThingType Boolean

Deprecates a thing type. You can not associate new things with deprecated thing type.

Requires permission to access the DeprecateThingType action.

id String
The thing type id.
tags List<Property Map>
An array of key-value pairs to apply to this resource.
thingTypeProperties Property Map
The thing type properties for the thing type to create. It contains information about the new thing type including a description, a list of searchable thing attribute names, and a list of propagating attributes. After a thing type is created, you can only update Mqtt5Configuration .

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

ThingTypePropagatingAttribute

UserPropertyKey This property is required. string
The key of the MQTT 5 user property, which is a key-value pair.
ConnectionAttribute Pulumi.AwsNative.IoT.ThingTypePropagatingAttributeConnectionAttribute
The attribute associated with the connection details.
ThingAttribute string
The thing attribute that is propagating for MQTT 5 message enrichment.
UserPropertyKey This property is required. string
The key of the MQTT 5 user property, which is a key-value pair.
ConnectionAttribute ThingTypePropagatingAttributeConnectionAttribute
The attribute associated with the connection details.
ThingAttribute string
The thing attribute that is propagating for MQTT 5 message enrichment.
userPropertyKey This property is required. String
The key of the MQTT 5 user property, which is a key-value pair.
connectionAttribute ThingTypePropagatingAttributeConnectionAttribute
The attribute associated with the connection details.
thingAttribute String
The thing attribute that is propagating for MQTT 5 message enrichment.
userPropertyKey This property is required. string
The key of the MQTT 5 user property, which is a key-value pair.
connectionAttribute ThingTypePropagatingAttributeConnectionAttribute
The attribute associated with the connection details.
thingAttribute string
The thing attribute that is propagating for MQTT 5 message enrichment.
user_property_key This property is required. str
The key of the MQTT 5 user property, which is a key-value pair.
connection_attribute ThingTypePropagatingAttributeConnectionAttribute
The attribute associated with the connection details.
thing_attribute str
The thing attribute that is propagating for MQTT 5 message enrichment.
userPropertyKey This property is required. String
The key of the MQTT 5 user property, which is a key-value pair.
connectionAttribute ":ClientId" | ":Thing.ThingName"
The attribute associated with the connection details.
thingAttribute String
The thing attribute that is propagating for MQTT 5 message enrichment.

ThingTypePropagatingAttributeConnectionAttribute

ThingTypePropertiesProperties

Mqtt5Configuration Pulumi.AwsNative.IoT.Inputs.ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
The configuration to add user-defined properties to enrich MQTT 5 messages.
SearchableAttributes List<string>
A list of searchable thing attribute names.
ThingTypeDescription string
The description of the thing type.
Mqtt5Configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
The configuration to add user-defined properties to enrich MQTT 5 messages.
SearchableAttributes []string
A list of searchable thing attribute names.
ThingTypeDescription string
The description of the thing type.
mqtt5Configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
The configuration to add user-defined properties to enrich MQTT 5 messages.
searchableAttributes List<String>
A list of searchable thing attribute names.
thingTypeDescription String
The description of the thing type.
mqtt5Configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
The configuration to add user-defined properties to enrich MQTT 5 messages.
searchableAttributes string[]
A list of searchable thing attribute names.
thingTypeDescription string
The description of the thing type.
mqtt5_configuration ThingTypePropertiesPropertiesMqtt5ConfigurationProperties
The configuration to add user-defined properties to enrich MQTT 5 messages.
searchable_attributes Sequence[str]
A list of searchable thing attribute names.
thing_type_description str
The description of the thing type.
mqtt5Configuration Property Map
The configuration to add user-defined properties to enrich MQTT 5 messages.
searchableAttributes List<String>
A list of searchable thing attribute names.
thingTypeDescription String
The description of the thing type.

ThingTypePropertiesPropertiesMqtt5ConfigurationProperties

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi