Skip to content

create_ota_task_configuration

create_ota_task_configuration(
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    description: Optional[OtaDescription] = None,
    name: Optional[OtaTaskConfigurationName] = None,
    push_config: Optional[PushConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> CreateOtaTaskConfigurationResponse

Create a configuraiton for the over-the-air (OTA) task.

Parameters:

  • description (Optional[OtaDescription], default: None ) –

    A description of the over-the-air (OTA) task configuration.

  • name (Optional[OtaTaskConfigurationName], default: None ) –

    The name of the over-the-air (OTA) task.

  • push_config (Optional[PushConfig], default: None ) –

    Describes the type of configuration used for the over-the-air (OTA) task.

  • client_token (Optional[ClientToken], default: None ) –

    An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

Raises:

Source code in docs_src/capo_iot_managed_integrations/_services/io_t_managed_integrations.py
def create_ota_task_configuration(
    self,
    *,
    config_overrides: Optional[IoTManagedIntegrationsClientConfig] = None,
    description: Optional[
        "capo_iot_managed_integrations.types.ota_description.OtaDescription"
    ] = None,
    name: Optional[
        "capo_iot_managed_integrations.types.ota_task_configuration_name.OtaTaskConfigurationName"
    ] = None,
    push_config: Optional[
        "capo_iot_managed_integrations.types.push_config.PushConfig"
    ] = None,
    client_token: Optional[
        "capo_iot_managed_integrations.types.client_token.ClientToken"
    ] = None,
) -> "capo_iot_managed_integrations.types.create_ota_task_configuration_response.CreateOtaTaskConfigurationResponse":
    """<p>Create a configuraiton for the over-the-air (OTA) task.</p>

    Args:
        description: <p>A description of the over-the-air (OTA) task configuration.</p>
        name: <p>The name of the over-the-air (OTA) task.</p>
        push_config: <p>Describes the type of configuration used for the over-the-air (OTA) task.</p>
        client_token: <p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>

    Raises:
        capo_iot_managed_integrations.errors.access_denied_exception.AccessDeniedException: <p>User is not authorized.</p>
        capo_iot_managed_integrations.errors.conflict_exception.ConflictException: <p>There is a conflict with the request.</p>
        capo_iot_managed_integrations.errors.internal_server_exception.InternalServerException: <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
        capo_iot_managed_integrations.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot_managed_integrations.errors.validation_exception.ValidationException: <p>A validation error occurred when performing the API request.</p>
        capo_iot_managed_integrations.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_managed_integrations.types.create_ota_task_configuration_request.CreateOtaTaskConfigurationRequest]",
    ) -> OperationResponse[
        "capo_iot_managed_integrations.types.create_ota_task_configuration_response.CreateOtaTaskConfigurationResponse"
    ]:
        import capo_iot_managed_integrations._operations.iot_managed_integrations.create_ota_task_configuration

        output, http_response = (
            capo_iot_managed_integrations._operations.iot_managed_integrations.create_ota_task_configuration.create_ota_task_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_iot_managed_integrations.types.create_ota_task_configuration_request.CreateOtaTaskConfigurationRequest",
    ) -> dict[str, Any]:
        import capo_iot_managed_integrations.types.create_ota_task_configuration_request

        return capo_iot_managed_integrations.types.create_ota_task_configuration_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateOtaTaskConfiguration", redact_input=_redact_input),
    )
    input_: capo_iot_managed_integrations.types.create_ota_task_configuration_request.CreateOtaTaskConfigurationRequest = {}
    if description is not None:
        input_["description"] = description
    if name is not None:
        input_["name"] = name
    if push_config is not None:
        input_["push_config"] = push_config
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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