Skip to content

deprecate_thing_type async 

deprecate_thing_type(
    thing_type_name: ThingTypeName,
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    undo_deprecate: Optional[UndoDeprecate] = None,
) -> DeprecateThingTypeResponse

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

Requires permission to access the DeprecateThingType action.

Parameters:

  • thing_type_name (ThingTypeName) –

    The name of the thing type to deprecate.

  • undo_deprecate (Optional[UndoDeprecate], default: None ) –

    Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

Raises:

Source code in docs_src/capo_iot/_services/async_io_t.py 
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
async def deprecate_thing_type(
    self,
    thing_type_name: "capo_iot.types.thing_type_name.ThingTypeName",
    *,
    config_overrides: Optional[AsyncIoTClientConfig] = None,
    undo_deprecate: Optional["capo_iot.types.undo_deprecate.UndoDeprecate"] = None,
) -> "capo_iot.types.deprecate_thing_type_response.DeprecateThingTypeResponse":
    """<p>Deprecates a thing type. You can not associate new things with deprecated thing type.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeprecateThingType</a> action.</p>

    Args:
        thing_type_name: <p>The name of the thing type to deprecate.</p>
        undo_deprecate: <p>Whether to undeprecate a deprecated thing type. If <b>true</b>, the thing type will not be deprecated anymore and you can associate it with things.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot.types.deprecate_thing_type_request.DeprecateThingTypeRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot.types.deprecate_thing_type_response.DeprecateThingTypeResponse"
    ]:
        import capo_iot._operations.aws_iot_service.deprecate_thing_type

        (
            output,
            http_response,
        ) = await capo_iot._operations.aws_iot_service.deprecate_thing_type.async_deprecate_thing_type(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeprecateThingType")
    )
    input_: capo_iot.types.deprecate_thing_type_request.DeprecateThingTypeRequest = {
        "thing_type_name": thing_type_name
    }
    if undo_deprecate is not None:
        input_["undo_deprecate"] = undo_deprecate

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output