create_bot ¶

def create_bot(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    username: "capo_wickr.types.generic_string.GenericString",
    group_id: "capo_wickr.types.generic_string.GenericString",
    challenge: "capo_wickr.types.sensitive_string.SensitiveString",
    *,
    config_overrides: Optional[WickrClientConfig] = None,
    display_name: Optional["capo_wickr.types.generic_string.GenericString"] = None,
) -> "capo_wickr.types.create_bot_response.CreateBotResponse":
    """<p>Creates a new bot in a specified Wickr network. Bots are automated accounts that can send and receive messages, enabling integration with external systems and automation of tasks.</p>

    Args:
        network_id: <p>The ID of the Wickr network where the bot will be created.</p>
        username: <p>The username for the bot. This must be unique within the network and follow the network's naming conventions.</p>
        display_name: <p>The display name for the bot that will be visible to users in the network.</p>
        group_id: <p>The ID of the security group to which the bot will be assigned.</p>
        challenge: <p>The password for the bot account.</p>

    Raises:
        capo_wickr.errors.bad_request_error.BadRequestError: <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
        capo_wickr.errors.forbidden_error.ForbiddenError: <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
        capo_wickr.errors.internal_server_error.InternalServerError: <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
        capo_wickr.errors.rate_limit_error.RateLimitError: <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
        capo_wickr.errors.resource_not_found_error.ResourceNotFoundError: <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
        capo_wickr.errors.unauthorized_error.UnauthorizedError: <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
        capo_wickr.errors.validation_error.ValidationError: <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
        capo_wickr.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Create bot successfully

        >>> client.create_bot(network_id='12345678', username='analytics_bot', display_name='Analytics Bot', challenge='SecureP@ssw0rd123', group_id='analytics_group')
        Create bot - username unavailable

        >>> client.create_bot(network_id='12345678', username='support_bot', display_name='Support Bot', group_id='default_group', challenge='SecureP@ssw0rd123')
        Create bot - invalid username format

        >>> client.create_bot(network_id='12345678', username='bot@invalid', display_name='Test Bot', group_id='default_group', challenge='SecureP@ssw0rd123')
    """

    def _handler(
        req: "OperationRequest[capo_wickr.types.create_bot_request.CreateBotRequest]",
    ) -> OperationResponse[
        "capo_wickr.types.create_bot_response.CreateBotResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.create_bot

        output, http_response = (
            capo_wickr._operations.wickr_admin_api.create_bot.create_bot(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_wickr.types.create_bot_request.CreateBotRequest",
    ) -> dict[str, Any]:
        import capo_wickr.types.create_bot_request

        return capo_wickr.types.create_bot_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateBot", redact_input=_redact_input)
    )
    input_: capo_wickr.types.create_bot_request.CreateBotRequest = {
        "network_id": network_id,
        "username": username,
        "group_id": group_id,
        "challenge": challenge,
    }
    if display_name is not None:
        input_["display_name"] = display_name

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