Skip to content

create_wireless_gateway_task_definition

create_wireless_gateway_task_definition(
    auto_create_tasks: AutoCreateTasks,
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    name: Optional[WirelessGatewayTaskName] = None,
    update: Optional[UpdateWirelessGatewayTaskCreate] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    tags: Optional[TagList] = None,
) -> CreateWirelessGatewayTaskDefinitionResponse

Creates a gateway task definition.

Parameters:

  • auto_create_tasks (AutoCreateTasks) –

    Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

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

    The name of the new resource.

  • update (Optional[UpdateWirelessGatewayTaskCreate], default: None ) –

    Information about the gateways to update.

  • client_request_token (Optional[ClientRequestToken], default: None ) –

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

  • tags (Optional[TagList], default: None ) –

    The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Raises:

Source code in docs_src/capo_iot_wireless/_services/io_t_wireless.py
def create_wireless_gateway_task_definition(
    self,
    auto_create_tasks: "capo_iot_wireless.types.auto_create_tasks.AutoCreateTasks",
    *,
    config_overrides: Optional[IoTWirelessClientConfig] = None,
    name: Optional[
        "capo_iot_wireless.types.wireless_gateway_task_name.WirelessGatewayTaskName"
    ] = None,
    update: Optional[
        "capo_iot_wireless.types.update_wireless_gateway_task_create.UpdateWirelessGatewayTaskCreate"
    ] = None,
    client_request_token: Optional[
        "capo_iot_wireless.types.client_request_token.ClientRequestToken"
    ] = None,
    tags: Optional["capo_iot_wireless.types.tag_list.TagList"] = None,
) -> "capo_iot_wireless.types.create_wireless_gateway_task_definition_response.CreateWirelessGatewayTaskDefinitionResponse":
    """<p>Creates a gateway task definition.</p>

    Args:
        auto_create_tasks: <p>Whether to automatically create tasks using this task definition for all gateways with the specified current version. If <code>false</code>, the task must me created by calling <code>CreateWirelessGatewayTask</code>.</p>
        name: <p>The name of the new resource.</p>
        update: <p>Information about the gateways to update.</p>
        client_request_token: <p>Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency in Amazon EC2 API requests</a>.</p>
        tags: <p>The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.</p>

    Raises:
        capo_iot_wireless.errors.access_denied_exception.AccessDeniedException: <p>User does not have permission to perform this action.</p>
        capo_iot_wireless.errors.conflict_exception.ConflictException: <p>Adding, updating, or deleting the resource can cause an inconsistent state.</p>
        capo_iot_wireless.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing a request.</p>
        capo_iot_wireless.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource does not exist.</p>
        capo_iot_wireless.errors.throttling_exception.ThrottlingException: <p>The request was denied because it exceeded the allowed API request rate.</p>
        capo_iot_wireless.errors.validation_exception.ValidationException: <p>The input did not meet the specified constraints.</p>
        capo_iot_wireless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_wireless.types.create_wireless_gateway_task_definition_request.CreateWirelessGatewayTaskDefinitionRequest]",
    ) -> OperationResponse[
        "capo_iot_wireless.types.create_wireless_gateway_task_definition_response.CreateWirelessGatewayTaskDefinitionResponse"
    ]:
        import capo_iot_wireless._operations.iotwireless.create_wireless_gateway_task_definition

        output, http_response = (
            capo_iot_wireless._operations.iotwireless.create_wireless_gateway_task_definition.create_wireless_gateway_task_definition(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateWirelessGatewayTaskDefinition")
    )
    input_: capo_iot_wireless.types.create_wireless_gateway_task_definition_request.CreateWirelessGatewayTaskDefinitionRequest = {
        "auto_create_tasks": auto_create_tasks
    }
    if name is not None:
        input_["name"] = name
    if update is not None:
        input_["update"] = update
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if tags is not None:
        input_["tags"] = tags

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