Skip to content

delete_dynamic_thing_group

delete_dynamic_thing_group(
    thing_group_name: ThingGroupName,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    expected_version: Optional[OptionalVersion] = None,
) -> DeleteDynamicThingGroupResponse

Deletes a dynamic thing group.

Requires permission to access the DeleteDynamicThingGroup action.

Parameters:

  • thing_group_name (ThingGroupName) –

    The name of the dynamic thing group to delete.

  • expected_version (Optional[OptionalVersion], default: None ) –

    The expected version of the dynamic thing group to delete.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def delete_dynamic_thing_group(
    self,
    thing_group_name: "capo_iot.types.thing_group_name.ThingGroupName",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    expected_version: Optional[
        "capo_iot.types.optional_version.OptionalVersion"
    ] = None,
) -> "capo_iot.types.delete_dynamic_thing_group_response.DeleteDynamicThingGroupResponse":
    """<p>Deletes a dynamic thing group.</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">DeleteDynamicThingGroup</a> action.</p>

    Args:
        thing_group_name: <p>The name of the dynamic thing group to delete.</p>
        expected_version: <p>The expected version of the dynamic thing group to delete.</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.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.version_conflict_exception.VersionConflictException: <p>An exception thrown when the version of an entity specified with the <code>expectedVersion</code> parameter does not match the latest version in the system.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.delete_dynamic_thing_group_request.DeleteDynamicThingGroupRequest]",
    ) -> OperationResponse[
        "capo_iot.types.delete_dynamic_thing_group_response.DeleteDynamicThingGroupResponse"
    ]:
        import capo_iot._operations.aws_iot_service.delete_dynamic_thing_group

        output, http_response = (
            capo_iot._operations.aws_iot_service.delete_dynamic_thing_group.delete_dynamic_thing_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDynamicThingGroup")
    )
    input_: capo_iot.types.delete_dynamic_thing_group_request.DeleteDynamicThingGroupRequest = {
        "thing_group_name": thing_group_name
    }
    if expected_version is not None:
        input_["expected_version"] = expected_version

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output